Repository.Project.SetCurrentProject: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
m (Protected "Repository.SetCurrentProject" ([edit=sysop] (indefinite) [move=sysop] (indefinite)) [cascading])
No edit summary
Line 9: Line 9:
{{APIName|)}}
{{APIName|)}}
{{APIPrefix|As Boolean}}<br>
{{APIPrefix|As Boolean}}<br>
{{APIComment|Opens (sets as current) a project with the specified ID. If 0 is passed, a fist available project will be set as current.}}
{{APIComment|Opens (sets as current) a project with the specified ID. If 0 is passed, a first available project will be set as current.}}


== Parameters ==
== Parameters ==

Revision as of 16:25, 10 February 2014


Sets the current project to the specified Project ID. Returns the Boolean status.

Method Syntax

SetCurrentProject( ByVal ProjectID As Integer ) As Boolean
Opens (sets as current) a project with the specified ID. If 0 is passed, a first available project will be set as current.

Parameters

ProjectID Set the current project to this ID.

Usage Example

Declare a new repository connection class.

       Private WithEvents MyRepository As New Repository

Connect to the Synthesis repository.

       Dim Success As Boolean = False
       Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")

Set the current project to the desired ID.

       Dim IDChangeSuccess As Boolean = False
       If MyRepository.SetCurrentProject(1) Then
          IDChangeSuccess = True
       End If