Repository.ConnectToRepository: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}
{{Template:Repository.ConnectToRepository.Cmt}}
{{Template:APIBreadcrumb|9|Repository}}


If the extension of the file is *.rserp, then it connects to the enterprise database described in the file. Otherwise MS Access repository is assumed.
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.


== Syntax ==
== Syntax ==
*ConnectToRepository({{APIPrefix|ByVal}} FileName {{APIPrefix|As String}}){{APIPrefix|As Boolean}}
''object''.'''ConnectToRepository(FileName As String)''' As Boolean


Parameters
where ''object'' is a variable that represents a Repository object.
:''FileName'': The path to the Synthesis Repository you will connect to.


{{Template:BooleanReturn.Cmt}}
=== Parameters ===
{| {{APITable}}
|-
|FileName||'''String'''. The complete path to the Synthesis Repository you will connect to.
|}


== Usage Example ==
 
{{Template:RepositoryFull.Ex}}
== Example ==
This example assumes that a file called "RSRepository1.rsr10" exists in the C: drive. This code sample ignores the return value.
 
'''VBA|VB.NET'''<br>
Dim MyRepository As New Repository
MyRepository.ConnectToRepository("C:\RSRepository1.rsr10")

Revision as of 22:23, 10 July 2015

APIWiki.png


Member of: SynthesisAPI9Repository

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.

Syntax

object.ConnectToRepository(FileName As String) As Boolean

where object is a variable that represents a Repository object.

Parameters

Name Description
FileName String. The complete path to the Synthesis Repository you will connect to.


Example

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

VBA|VB.NET
Dim MyRepository As New Repository MyRepository.ConnectToRepository("C:\RSRepository1.rsr10")