Repository.Project.GetAllProjects: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
m (Protected "Repository.GetAllProjects" ([edit=sysop] (indefinite) [move=sysop] (indefinite)) [cascading])
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:APIClass|Repository Class|Repository}}
Gets a list of the projects. Returns a list of [[NameIdPair Class|NameIdPair]]
{{Template:Repository.GetAllProjects.Cmt}}


== Method Syntax==
== Syntax==
{{APIName|'''GetAllProjects'''()}}
GetAllProjects(){{APIPrefix|As}}[[NameIdPair Class|NameIdPair]]()
{{APIPrefix|As}}
{{APIName|[[NameIdPair Class|NameIdPair]]()}}<br>
{{APIComment|Returns an array containing all project names and their IDs from the current repository.}}


== Usage Example ==
== Usage Example ==

Revision as of 17:12, 27 February 2014


Returns an array containing all project names and their IDs from the current repository.

Syntax

GetAllProjects()AsNameIdPair()

Usage Example

Declare a new repository connection class.

       Private WithEvents MyRepository As New Repository

Connect to the Synthesis repository.

       Dim Success As Boolean = False
       Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")

Get the list of Projects in the connected repository.

       Dim ListOfProjects() As NameIdPair
       ListOfProjects = MyRepository.GetAllProjects()