Repository.Project.GetCurrentProject: Difference between revisions

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


== Syntax==


*GetCurrentProject(){{APIPrefix|As}}[[NameIdPair Class|NameIdPair]]
<onlyinclude>Returns a '''[[NameIdPair Class|NameIDPair]]''' object that represents the name and ID pair of the current project.</onlyinclude>


== Usage Example ==
== Syntax ==
In this usage example, a project is opened in a Synthesis repository, and the ID of the project is retrieved.
'''.Project.GetCurrentProject'''
  {{APIComment|'Declare a new repository connection object. See [[Repository Class|Repository]].}}
 
  Dim MyRepository As New Repository
 
 
== Example ==
{{APIComment|'Connect to a Synthesis repository.}}
'''VBA|VB.NET'''
  Dim Success As Boolean = False
  Success = MyRepository.ConnectToRepository("C:\Users\Name\Documents\ReliaSoft\Files\repository.rsr9")
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
 
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Get a list of the names/IDs of projects in the connected repository.}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
  Dim ListOfProjects() As NameIdPair
  ListOfProjects = MyRepository.Project.GetAllProjects()
  {{APIComment|'Set the first available project in the repository as the current project.}}
 
  MyRepository.Project.SetCurrentProject(1)
  {{APIComment|'Open the first project in the list.}}
  MyRepository.Project.SetCurrentProject(ListOfProjects(0).ID)
  {{APIComment|'Output example: Display the name and ID of the current project.}}
 
  Dim ProjectName {{APIPrefix|As}} String
  {{APIComment|'Get the ID of the opened project.}}
  Dim ProjectID {{APIPrefix|As}} Integer
  Dim ID As Integer
  ProjectName = MyRepository.Project.GetCurrentProject.Name
  ID = MyRepository.Project.GetCurrentProject()
  ProjectID = MyRepository.Project.GetCurrentProject.ID
 
  MsgBox ({{APIString|"You are currently connected to: "}} & ProjectName & {{APIString|", ID#"}} & ProjectID)
{{APIComment|'Disconnect from the repository.}}
  MyRepository.DisconnectFromRepository()

Latest revision as of 17:30, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns a NameIDPair object that represents the name and ID pair of the current project.

Syntax

.Project.GetCurrentProject


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

 'Set the first available project in the repository as the current project. 
  MyRepository.Project.SetCurrentProject(1)

 'Output example: Display the name and ID of the current project. 
  Dim ProjectName As String
  Dim ProjectID As Integer
  ProjectName = MyRepository.Project.GetCurrentProject.Name
  ProjectID = MyRepository.Project.GetCurrentProject.ID
  MsgBox ("You are currently connected to: " & ProjectName & ", ID#" & ProjectID)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Project.GetCurrentProject&oldid=64265"