Repository.ConnectToOracleRepository: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:APIBreadcrumb|9|Repository}}
{{Template:Repository.ConnectToOracleRepository.Cmt}}
{{Template:API}}
Connects to an Oracle repository that you specify. Returns a '''Boolean''' value; when true, indicates a successful connection to the repository.  


== Syntax ==
== Syntax ==
*ConnectToOracleRepository({{APIPrefix|ByVal}} Port {{APIPrefix|As Integer}}, {{APIPrefix|ByVal}} Service {{APIPrefix|As String}}, {{APIPrefix|ByVal}} Host {{APIPrefix|As String}}, {{APIPrefix|ByVal}} Schema {{APIPrefix|As String}}, {{APIPrefix|ByVal}} Password {{APIPrefix|As String}}){{APIPrefix|As Boolean}}
''object''.'''ConnectToOracleRepository(''Port'', ''Service'', ''Host'', ''Schema'', ''Password'')'''


Parameters
where ''object'' is a variable that represents a Repository object.
:''Port'': The server port for the Oracle repository.


:''Service'': The repository service identifier.
===Parameters===
{| {{APITable}}
|-
|Port{{APIParam|Required}}||'''Integer'''. The server port for the Oracle repository.
|-
|Service{{APIParam|Required}}||'''String'''. The repository service identifier.  
|-
|Host{{APIParam|Required}}||'''String'''. The repository host identifier.
|-
|Schema{{APIParam|Required}}||'''String'''. The repository schema.
|-
|Password{{APIParam|Required}}||'''String'''. The repository password. (Your Windows login credentials are used for access to the database; use your Windows password.)
|}


:''Host'': The repository host identifier.


:''Schema'': The repository schema.
==Example==


:''Password'': The repository password. (Your Windows login credentials are used for access to the database; use your Windows password.)
'''VBA|VB.NET'''<br>
 
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{Template:BooleanReturn.Cmt}}
MyRepository.ConnectToOracleRepository({{APIString|"OraclePort"}}, {{APIString|"OracleService"}},{{APIString|"OracleHost"}}, {{APIString|"OracleSchema"}}, {{APIString|"OraclePassword"}})
 
== Usage Example ==
 
  {{APIComment|'Declare a new repository connection object.}}
  Dim MyRepository As New Repository
 
{{APIComment|'Connect to the Synthesis repository.}}
  Dim Success As Boolean
  Success = MyRepository.ConnectToOracleRepository("OraclePort", "OracleService",  
    "OracleHost", "OracleSchema", "OraclePassword")

Revision as of 16:52, 13 July 2015

Member of: SynthesisAPI9Repository

APIWiki.png


Connects to an Oracle repository that you specify. Returns a Boolean value; when true, indicates a successful connection to the repository.

Syntax

object.ConnectToOracleRepository(Port, Service, Host, Schema, Password)

where object is a variable that represents a Repository object.

Parameters

Name Description
Portborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
Name Status Integer. The server port for the Oracle repository.
Serviceborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
Name Status String. The repository service identifier.
Hostborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
Name Status String. The repository host identifier.
Schemaborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
Name Status String. The repository schema.
Passwordborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
Name Status String. The repository password. (Your Windows login credentials are used for access to the database; use your Windows password.)


Example

VBA|VB.NET
Dim MyRepository As New Repository MyRepository.ConnectToOracleRepository("OraclePort", "OracleService","OracleHost", "OracleSchema", "OraclePassword")