Repository.URD.GetAllURDs: 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 a list of all existing URDs in the current project. Returns a '''[[CURD Class|cURD]]''' object array that contains the URD names, ID numbers and other information.  
Gets a list of all existing URDs in the current project. Returns a '''[[CURD Class|cURD]]''' object array that contains the URD names, ID numbers and other information.  
<noinclude>
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''URD.GetAllURDs()'''
'''.URD.GetAllURDs()'''


where ''object'' is a variable that represents a Repository object.


== Example ==
== Example ==
Line 13: Line 13:
  '''VBA|VB.NET'''
  '''VBA|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 a list of all URDs in project #1.}}
  {{APIComment|'Get a list of all URDs in project #1.}}

Revision as of 18:13, 20 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets a list of all existing URDs in the current project. Returns a cURD object array that contains the URD names, ID numbers and other information.

Syntax

.URD.GetAllURDs()


Example

This example assumes that URDs exist in the first available project of a repository.

VBA|VB.NET

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

 'Get a list of all URDs in project #1. 
 Dim ListofURDs() As cURD
 MyRepository.Project.SetCurrentProject (1)  
 ListofURDs = MyRepository.URD.GetAllURDs()

 'Output sample: Display the name and ID of the first available URD in the project. 
 Dim URDName As String
 Dim URDID As Integer
 URDName = ListofURDs(0).Name
 URDID = ListofURDs(0).ID
 MsgBox ("The first URD is: " & URDName & ", ID#" & URDID)