Repository.Project.GetCurrentProject: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(26 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
Gets the name and ID of the current project.


== Property Syntax==


{{Template:Repository.GetCurrentProject}}
<onlyinclude>Returns a '''[[NameIdPair Class|NameIDPair]]''' object that represents the name and ID pair of the current project.</onlyinclude>


== Usage Example ==
== Syntax ==
{{APIComment|Declare a new repository connection class.}}
'''.Project.GetCurrentProject'''
        Private WithEvents MyRepository As New Repository


{{APIComment|Connect to the Synthesis repository.}}
        Dim Success As Boolean = False
        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")


{{APIComment|Get the name and ID pair of the current Project in the connected repository.}}
== Example ==
        Dim CurrentProject As [[NameIdPair Class|NameIdPair]]
'''VBA|VB.NET'''
        CurrentProject = MyRepository.GetCurrentProject()
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
{{APIComment|'Set the first available project in the repository as the current project.}}
  MyRepository.Project.SetCurrentProject(1)
{{APIComment|'Output example: Display the name and ID of the current project.}}
  Dim ProjectName {{APIPrefix|As}} String
  Dim ProjectID {{APIPrefix|As}} Integer
  ProjectName = MyRepository.Project.GetCurrentProject.Name
  ProjectID = MyRepository.Project.GetCurrentProject.ID
  MsgBox ({{APIString|"You are currently connected to: "}} & ProjectName & {{APIString|", ID#"}} & ProjectID)

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)