Repository.Project.SetCurrentProject: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(24 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
Sets the current project to the specified Project ID.  Returns the Boolean status.


== Property Syntax==


{{Template:Repository.SetCurrentProject}}
<onlyinclude>Sets the current (active) project for the repository. Returns a '''Boolean''' value; when true, indicates a successful connection to that project.</onlyinclude>


== Parameters ==
== Syntax ==
'''ProjectID'''
'''.Project.SetCurrentProject'''(''ProjectID'')
Set the current project to this ID.


== Usage Example ==
=== Parameters ===
{{APIComment|Declare a new repository connection class.}}
''ProjectID''
        Private WithEvents MyRepository As New Repository
:Required. Integer. The ID number of the project.


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


{{APIComment|Set the current project to the desired ID.}}
== Example ==
        Dim IDChangeSuccess As Boolean = False
 
        If MyRepository.SetCurrentProject(1) Then
'''VBA|VB.NET'''
          IDChangeSuccess = True
        End If
{{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)

Latest revision as of 15:29, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Sets the current (active) project for the repository. Returns a Boolean value; when true, indicates a successful connection to that project.

Syntax

.Project.SetCurrentProject(ProjectID)

Parameters

ProjectID

Required. Integer. The ID number of the project.


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)