Repository.URD.GetAllURDs: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:APIBreadcrumb|10|Repository}}
{{Template:Repository.GetAllURDs.Cmt}}
{{Template:API}}
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.  


== Syntax==
== Syntax ==
*GetAllURDs(){{APIPrefix|As}}[[cURD Class|cURD]]()
''object''.'''URD.GetAllURDs()'''


== Usage Example ==
where ''object'' is a variable that represents a Repository object.
<div style="margin-right: 150px;">
 
  {{APIComment|'Declare a new repository connection object.}}
== Example ==
  Dim MyRepository As New Repository
This example assumes that URDs exist in the first available project of a repository.
 
 
  {{APIComment|'Connect to the Synthesis repository.}}
'''VBA|VB.NET'''
  Dim Success As Boolean = False
   
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
 
  {{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Set a first available project as current.}}
   MyRepository.Project.SetCurrentProject(0)
  {{APIComment|'Get a list of all URDs in project #1.}}
  {{APIPrefix|Dim}} ListofURDs() {{APIPrefix|As}} cURD
   MyRepository.Project.SetCurrentProject (1) 
  ListofURDs = MyRepository.URD.GetAllURDs()
   
   
  {{APIComment|'Get list of URDs.}}
  {{APIComment|'Output sample: Display the name and ID of the first available URD in the project.}}
   Dim ListOfURDs() as cURD
   {{APIPrefix|Dim}} URDName {{APIPrefix|As}} String
   ListOfURDs = MyRepository.URD.GetAllURDs()
  {{APIPrefix|Dim}} URDID {{APIPrefix|As}} Integer
</div>
  URDName = ListofURDs(0).Name
   URDID = ListofURDs(0).ID
  MsgBox ({{APIString|"The first URD is: "}} & URDName & {{APIString|", ID#"}} & URDID)

Revision as of 21:23, 14 July 2015

Member of: SynthesisAPI10Repository

APIWiki.png


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

object.URD.GetAllURDs()

where object is a variable that represents a Repository object.

Example

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

VBA|VB.NET

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis 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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.URD.GetAllURDs&oldid=59399"