Repository.ConnectToRepository: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:APIBreadcrumb|9|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:API}}
 
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.
 
<onlyinclude>Connects to a standard or enterprise repository. Returns a '''Boolean''' value; when true, indicates a successful connection to the repository.</onlyinclude>


== Syntax ==
== Syntax ==
''object''.'''ConnectToRepository(FileName)'''
'''.ConnectToRepository'''(''FileName'')
 
where ''object'' is a variable that represents a Repository object.


=== Parameters ===
=== Parameters ===
{| {{APITable}}
''FileName''
|-
:Required. String. The complete path to the Synthesis repository. If the file extension is not specified, it assumes that the file is a standard repository.
|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'''<br>
  '''VBA|VB.NET'''
  {{APIPrefix|Dim}}MyRepository{{APIPrefix|As New}}Repository
  MyRepository.ConnectToRepository({{APIString|"C:\RSRepository1.rsr10"}})
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
MyRepository.ConnectToRepository({{APIString|"C:\RSRepository1.rsr10"}})

Latest revision as of 21:53, 13 November 2015

APIWiki.png


Member of: SynthesisAPI.Repository


Connects to a standard or enterprise repository. Returns a Boolean value; when true, indicates a successful connection to the repository.

Syntax

.ConnectToRepository(FileName)

Parameters

FileName

Required. String. The complete path to the Synthesis repository. If the file extension is not specified, it assumes that the file is a standard repository.


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")