Repository.Project.GetAllProjects: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(29 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:Repository.GetAllProjects.Cmt}}


== Syntax==
*GetAllProjects(){{APIPrefix|As}}[[NameIdPair Class|NameIdPair]]()


== Usage Example ==
<onlyinclude>Returns an array of '''[[NameIdPair Class|NameIDPair]]''' objects that represent the name and ID pairs of the projects associated with the Repository object.</onlyinclude>
  {{APIComment|'Declare a new repository connection class.}}
 
  Dim MyRepository As New Repository
== Syntax ==
 
'''.Project.GetAllProjects()'''
{{APIComment|'Connect to the Synthesis repository.}}
 
  Dim Success As Boolean = False
 
  Success = MyRepository.ConnectToRepository("C:\Users\Name\Documents\ReliaSoft\Files\repository.rsr9")
== Example ==
 
'''VBA|VB.NET'''
  {{APIComment|'Get a list of names/IDs describing the projects in the current repository.}}
  Dim ListOfProjects() As NameIdPair
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  ListOfProjects = MyRepository.GetAllProjects()
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
 
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
  {{APIComment|'Get the first project name in the list.}}
 
  Dim ProjectName As String
  {{APIComment|'Get a list of all projects in the repository.}}  
  String = ListOfProjects(0).Name
  {{APIPrefix|Dim}} ListofProjects() {{APIPrefix|As}} NameIDPair
  ListOfProjects = MyRepository.Project.GetAllProjects
  {{APIComment|'Output sample: Display the number of projects in the repository.}}
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  NumberofElements = UBound(ListofProjects) - LBound(ListofProjects) + 1
  MsgBox (NumberofElements)

Latest revision as of 18:54, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns an array of NameIDPair objects that represent the name and ID pairs of the projects associated with the Repository object.

Syntax

.Project.GetAllProjects()


Example

VBA|VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 'Get a list of all projects in the repository.  
  Dim ListofProjects() As NameIDPair
  ListOfProjects = MyRepository.Project.GetAllProjects

 'Output sample: Display the number of projects in the repository. 
  Dim NumberofElements As Integer
  NumberofElements = UBound(ListofProjects) - LBound(ListofProjects) + 1
  MsgBox (NumberofElements)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Project.GetAllProjects&oldid=64321"