Repository.URD.GetURD: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:Repository.GetURD.Cmt}}


== Syntax==
*GetURD({{APIPrefix|As}}[[cURD Class|cURD]])


== Usage Example ==
<onlyinclude>Returns a '''[[CURD Class|cURD]]''' object that represents a given URD resource in the current project. Returns nothing if the URD does not exist or is not in the current project.</onlyinclude>
<div style="margin-right: 150px;">
 
  {{APIComment|'Declare a new repository connection object.}}
== Syntax ==
  Dim MyRepository As New Repository
'''.URD.GetURD'''(''ID'')
 
 
  {{APIComment|'Connect to the Synthesis repository.}}
=== Parameters ===
  Dim Success As Boolean = False
''ID''
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
:Required. Integer. The ID number of the URD to retrieve.
 
 
  {{APIComment|'Get URD.}}
 
  Dim GetURD() as cURD
== Example ==
  GetURD= MyRepository.URD.GetURD()
This example assumes that a URD with ID #1 exists in the first project of a Synthesis repository.
</div>
'''VBA'''
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
   
{{APIComment|'Get URD #1 from project #1.}}
  {{APIPrefix|Dim}} MyURD {{APIPrefix|As}} cURD
  MyRepository.Project.SetCurrentProject(1)
  {{APIPrefix|Set}} MyURD = MyRepository.URD.GetURD(1)
  {{APIComment|'Output sample: Display the name and ID of the URD.}}
  {{APIPrefix|Dim}} URDName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} URDID {{APIPrefix|As}} Integer
  URDName = MyURD.Name
  URDID = MyURD.ID
  MsgBox ({{APIString|"You got "}} & URDName & {{APIString|", ID#"}} & URDID)
 
'''VB.NET'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
  {{APIComment|'Get URD #1 from project #1.}}
  {{APIPrefix|Dim}} MyURD {{APIPrefix|As}} cURD
  MyRepository.Project.SetCurrentProject(1)
  MyURD = MyRepository.URD.GetURD(1)
{{APIComment|'Output sample: Display the name and ID of the URD.}}
  {{APIPrefix|Dim}} URDName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} URDID {{APIPrefix|As}} Integer
  URDName = MyURD.Name
  URDID = MyURD.ID
  MsgBox ({{APIString|"You got "}} & URDName & {{APIString|", ID#"}} & URDID)

Latest revision as of 18:55, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns a cURD object that represents a given URD resource in the current project. Returns nothing if the URD does not exist or is not in the current project.

Syntax

.URD.GetURD(ID)

Parameters

ID

Required. Integer. The ID number of the URD to retrieve.


Example

This example assumes that a URD with ID #1 exists in the first project of a Synthesis repository. 

VBA

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
   
 'Get URD #1 from project #1. 
  Dim MyURD As cURD
  MyRepository.Project.SetCurrentProject(1)
  Set MyURD = MyRepository.URD.GetURD(1)

 'Output sample: Display the name and ID of the URD. 
  Dim URDName As String
  Dim URDID As Integer
  URDName = MyURD.Name
  URDID = MyURD.ID
  MsgBox ("You got " & URDName & ", ID#" & URDID)

VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")

 'Get URD #1 from project #1. 
  Dim MyURD As cURD
  MyRepository.Project.SetCurrentProject(1)
  MyURD = MyRepository.URD.GetURD(1)

 'Output sample: Display the name and ID of the URD. 
  Dim URDName As String
  Dim URDID As Integer
  URDName = MyURD.Name
  URDID = MyURD.ID
  MsgBox ("You got " & URDName & ", ID#" & URDID)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.URD.GetURD&oldid=64329"