Repository.ConnectToRepository: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|9, 10|[[Repository Class|Repository]]}}</noinclude>
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|9, 10|.[[Repository Class|Repository]]}}</noinclude>


Connects to a Synthesis repository  (*.rsr9, *rsr10* or *.rserp) that you specify. If the file extension is not specified, it assumes that the file type is a standard database. Returns a '''Boolean''' value; when true, indicates a successful connection to the repository.
 
Connects to a Synthesis repository  (*.rsr9, *rsr10* or *.rserp) that you specify. Returns a '''Boolean''' value; when true, indicates a successful connection to the repository.
<noinclude>
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''ConnectToRepository(''FileName'')'''
'''.ConnectToRepository'''(''FileName'')
 
where ''object'' is a variable that represents a Repository object.


=== Parameters ===
=== Parameters ===
{| {{APITable}}
''FileName''
|-
:String. The complete path to the Synthesis Repository. If the file extension is not specified, it assumes that the file is a standard repository (*.rsr9, *rsr10).
|FileName{{APIParam|Required}}||'''String'''. The complete path to the Synthesis Repository you will connect to.
|}




== Example ==
== Example ==
This example assumes that a file called "RSRepository1.rsr10" exists in the C: drive. This code sample ignores the return value.  
This example assumes that a file called "RSRepository1.rsr10" exists in the C: drive. The code ignores the return value.  


  '''VBA|VB.NET'''
  '''VBA|VB.NET'''

Revision as of 17:17, 20 July 2015

APIWiki.png


Member of: SynthesisAPI9, 10.Repository


Connects to a Synthesis repository (*.rsr9, *rsr10* or *.rserp) that you specify. Returns a Boolean value; when true, indicates a successful connection to the repository.

Syntax

.ConnectToRepository(FileName)

Parameters

FileName

String. The complete path to the Synthesis Repository. If the file extension is not specified, it assumes that the file is a standard repository (*.rsr9, *rsr10).


Example

This example assumes that a file called "RSRepository1.rsr10" exists in the C: drive. The code ignores the return value.

VBA|VB.NET

Dim MyRepository As New Repository
MyRepository.ConnectToRepository("C:\RSRepository1.rsr10")