Repository.Project.SetCurrentProject: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:APIBreadcrumb|10|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:API}}
 
Connects to a project that you specify and sets it as the current (active) project. Returns a '''Boolean''' value; when true, indicates a successful connection to the project.
 
<onlyinclude>Sets the current (active) project for the repository. Returns a '''Boolean''' value; when true, indicates a successful connection to that project.</onlyinclude>


== Syntax ==
== Syntax ==
''object''.'''Project.SetCurrentProject(''ProjectID'')'''
'''.Project.SetCurrentProject'''(''ProjectID'')
 
where ''object'' is a variable that represents a Repository object.


=== Parameters ===
=== Parameters ===
{| {{APITable}}
''ProjectID''
|-
:Required. Integer. The ID number of the project.
|ProjectID{{APIParam|Required}}||'''Integer'''. The ID number of the project.
|}




== Example ==
== Example ==


  '''VBA|VB.NET'''<br>
  '''VBA|VB.NET'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
  {{APIComment|'Set the first project in the repository as the current project.}}
  {{APIComment|'Set the first available project in the repository as the current project.}}
{{APIComment|'This is similar to opening the first project shown in the project list of a Synthesis application.}}
   MyRepository.Project.SetCurrentProject(1)
   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)