Repository.URD.GetAllURDs: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:




<onlyinclude>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.</onlyinclude>  
<onlyinclude>Gets a list of URDs associated with a project. Returns a '''[[CURD Class|cURD]]''' object array that contains all the URDs in that project.</onlyinclude>  


== Syntax ==
== Syntax ==
Line 23: Line 23:
   ListofURDs = MyRepository.URD.GetAllURDs()
   ListofURDs = MyRepository.URD.GetAllURDs()
   
   
  {{APIComment|'Output sample: Display the name and ID of the first available URD in the project.}}
  {{APIComment|'Output sample: Display the number of elements in the array.}}
   {{APIPrefix|Dim}} URDName {{APIPrefix|As}} String
   {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} URDID {{APIPrefix|As}} Integer
   NumberofElements = UBound(ListofURDs) - LBound(ListofURDs) + 1
   URDName = ListofURDs(0).Name
   MsgBox (NumberofElements)
  URDID = ListofURDs(0).ID
   MsgBox ({{APIString|"The first URD is: "}} & URDName & {{APIString|", ID#"}} & URDID)

Revision as of 22:41, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets a list of URDs associated with a project. Returns a cURD object array that contains all the URDs in that project.

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 number of elements in the array. 
 Dim NumberofElements As Integer
 NumberofElements = UBound(ListofURDs) - LBound(ListofURDs) + 1
 MsgBox (NumberofElements)