Repository.ConnectToRepository: Difference between revisions

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




Line 17: Line 19:
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToRepository({{APIString|"C:\RSRepository1.rsr10"}})
  MyRepository.ConnectToRepository({{APIString|"C:\RSRepository1.rsr10"}})
</noinclude>

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