Repository.Project.SetCurrentProject: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
(Created page with '{{Template:APIClass|Repository Class|Repository}} == Declaration == {{APIPrefix|Public Function}} {{APIName|SetCurrentProject(}} {{APIPrefix|ByVal}} {{APIName|ProjectID}} {{AP…')
 
No edit summary
 
(27 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}


== Declaration  ==


{{APIPrefix|Public Function}}
<onlyinclude>Sets the current (active) project for the repository. Returns a '''Boolean''' value; when true, indicates a successful connection to that project.</onlyinclude>
{{APIName|SetCurrentProject(}}
{{APIPrefix|ByVal}}
{{APIName|ProjectID}}
{{APIPrefix|As Integer}}
{{APIName|)}}
{{APIPrefix|As Boolean}}


{{APIComment|Opens (sets as current) a project with the specified ID. If 0 is passed, a fist available project will be set as current.}}
== Syntax ==
'''.Project.SetCurrentProject'''(''ProjectID'')
 
=== Parameters ===
''ProjectID''
:Required. Integer. The ID number of the project.
 
 
== Example ==
 
'''VBA|VB.NET'''
{{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)