Repository.URD.GetURD: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude>
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude>
 


Gets the URD with the designated ID number and returns it as a '''[[CURD Class|cURD]]''' object. Returns nothing if the URD does not exist or is not in the current project.  
Gets the URD with the designated ID number and returns it as a '''[[CURD Class|cURD]]''' object. Returns nothing if the URD does not exist or is not in the current project.  
<noinclude>
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''URD.GetURD(''ID'')'''
'''.URD.GetURD'''(''ID'')
 
where ''object'' is a variable that represents a Repository object.


=== Parameters ===
=== Parameters ===
{| {{APITable}}
''|ID''
|-
:Integer. The ID number of the URD to retrieve.
|ID{{APIParam|Required}}||'''Integer'''. The ID number of the URD to retrieve.
|}




Line 19: Line 16:
  '''VBA'''
  '''VBA'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Add code to connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
 
   
   
  {{APIComment|'Get URD #1 from project #1.}}
  {{APIComment|'Get URD #1 from project #1.}}
Line 36: Line 35:
  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Add code to connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
   
   
   
  {{APIComment|'Get URD #1 from project #1.}}
  {{APIComment|'Get URD #1 from project #1.}}

Revision as of 20:50, 20 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets the URD with the designated ID number and returns it as a cURD object. Returns nothing if the URD does not exist or is not in the current project.

Syntax

.URD.GetURD(ID)

Parameters

|ID

Integer. The ID number of the URD to retrieve.


Example

This example assumes that a URD with ID#1 exists in a repository.

VBA

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 
  

 '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

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 


 '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)