Repository.Project.GetCurrentProject: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
m (Protected "Repository.GetCurrentProject" ([edit=sysop] (indefinite) [move=sysop] (indefinite)) [cascading])
No edit summary
 
(23 intermediate revisions by 3 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.


== Method Syntax==


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


== Syntax ==
'''.Project.GetCurrentProject'''


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


{{APIComment|Connect to the Synthesis repository.}}
== Example ==
        Dim Success As Boolean = False
'''VBA|VB.NET'''
        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
 
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
{{APIComment|Get the name and ID pair of the current Project in the connected repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
        Dim CurrentProject As [[NameIdPair Class|NameIdPair]]
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
        CurrentProject = MyRepository.GetCurrentProject()
{{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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Project.GetCurrentProject&oldid=64265"