Repository.Project.GetAllProjects: 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 projects in the current repository. Returns a '''[[NameIdPair Class|NameIDPair]]''' object array that contains the project names and ID numbers.</onlyinclude>
<onlyinclude>Gets a list of projects associated with a Synthesis repository. Returns a '''[[NameIdPair Class|NameIDPair]]''' object array that contains all the projects in that repository.</onlyinclude>


== Syntax ==
== Syntax ==
Line 20: Line 20:
   ListOfProjects = MyRepository.Project.GetAllProjects()
   ListOfProjects = MyRepository.Project.GetAllProjects()
   
   
  {{APIComment|'Output sample: Display the name and ID of the first available project in the repository.}}
  {{APIComment|'Output sample: Display the number of elements in the array.}}
   {{APIPrefix|Dim}} ProjectName {{APIPrefix|As}} String
   {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} ProjectID {{APIPrefix|As}} Integer
   NumberofElements = UBound(ListofProjects) - LBound(ListofProjects) + 1
   ProjectName = ListofProjects(0).Name
   MsgBox (NumberofElements)
  ProjectID = ListofProjects(0).ID
   MsgBox ({{APIString|"The first project is: "}} & ProjectName & {{APIString|", ID#"}} & ProjectID)

Revision as of 15:36, 25 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets a list of projects associated with a Synthesis repository. Returns a NameIDPair object array that contains all the projects in that repository.

Syntax

.Project.GetAllProjects()


Example

VBA|VB.NET

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

 
 'Get a list of all projects in the repository.  
 Dim ListofProjects() As NameIDPair
 ListOfProjects = MyRepository.Project.GetAllProjects()

 'Output sample: Display the number of elements in the array. 
 Dim NumberofElements As Integer
 NumberofElements = UBound(ListofProjects) - LBound(ListofProjects) + 1
 MsgBox (NumberofElements)