Repository.ConnectToAccessRepository: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:APIBreadcrumb|9|Repository}}
{{Template:Repository.ConnectToAccessRepository.Cmt}}
{{Template:API}}
Connects to a standard repository (*.rsr9, *rsr10*) that you specify. This method cannot be used to connect to an enterprise repository (*.rserp). Returns a '''Boolean''' value; when true, indicates a successful connection to the repository.  
 


== Syntax ==
== Syntax ==
*ConnectToAccessRepository({{APIPrefix|ByVal}} FileName {{APIPrefix|As String}}) {{APIPrefix|As Boolean}}
''object''.'''ConnectToAccessRepository(FileName As String)''' As Boolean
 
where ''object'' is a variable that represents a Repository object.


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


{{Template:BooleanReturn.Cmt}}


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


  {{APIComment|'Declare a new repository connection object.}}
  '''VBA|VB.NET'''<br>
  Dim MyRepository As New Repository
Dim MyRepository As New Repository
 
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  {{APIComment|'Connect to the Synthesis repository.}}
  Dim Success As Boolean
  Success = MyRepository.ConnectToAccessRepository("C:\Users\Name\Documents\ReliaSoft\Files\repository.rsr10")

Revision as of 22:35, 10 July 2015

Member of: SynthesisAPI9Repository

APIWiki.png


Connects to a standard repository (*.rsr9, *rsr10*) that you specify. This method cannot be used to connect to an enterprise repository (*.rserp). Returns a Boolean value; when true, indicates a successful connection to the repository.


Syntax

object.ConnectToAccessRepository(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.ConnectToAccessRepository("C:\RSRepository1.rsr10")