Repository.Project.GetAllProjects: Difference between revisions

Revision as of 00:13, 18 September 2013

Gets a list of the projects. Returns a list of NameIdPair

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()

@@ Line 1: / Line 1: @@
 {{Template:APIClass|Repository Class|Repository}}
+Gets a list of the projects.  Returns a list of [[NameIdPair Class|NameIdPair]]
 == Property Syntax==
 {{Template:Repository.GetAllProjects}}
+== Usage Example ==
+{{APIComment|Declare a new repository connection class.}}
+        Private WithEvents MyRepository As New Repository
+{{APIComment|Connect to the Synthesis repository.}}
+        Dim Success As Boolean = False
+        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
+{{APIComment|Get the list of Projects in the connected repository.}}
+        Dim ListOfProjects() As [[NameIdPair Class|NameIdPair]]
+        ListOfProjects = MyRepository.GetAllProjects()