Repository.Project.GetAllProjects: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:APIBreadcrumb|10|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:API}}
 
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>Returns an array of '''[[NameIdPair Class|NameIDPair]]''' objects that represent the name and ID pairs of the projects associated with the Repository object.</onlyinclude>


== Syntax ==
== Syntax ==
''object''.'''Project.GetAllProjects()'''
'''.Project.GetAllProjects()'''
 
where ''object'' is a variable that represents a Repository object.




Line 12: Line 11:
  '''VBA|VB.NET'''
  '''VBA|VB.NET'''
   
   
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...'Add code to connect to a Synthesis repository.}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
  {{APIPrefix|Dim}} ListofProjects() {{APIPrefix|As}} NameIDPair
  {{APIComment|'Get a list of all projects in the repository.}}  
  ListOfProjects = MyRepository.Project.GetAllProjects()
  {{APIPrefix|Dim}} ListofProjects() {{APIPrefix|As}} NameIDPair
  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 projects in the repository.}}
  {{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)

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"