Repository.ConnectToSQLRepository: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 2: Line 2:


== Property Syntax==
== Property Syntax==
{{APIPrefix|Public Function}}
{{APIName|ConnectToSQLRepository(}}
{{APIPrefix|ByVal}}
{{APIName|ServerName}}
{{APIPrefix|As String, ByVal}}
{{APIName|DatabaseName}}
{{APIPrefix|As String, Optional ByVal}}
{{APIName|UseImpersonation}}
{{APIPrefix|As Boolean}}
=
{{APIPrefix|False, Optional ByVal}}
{{APIName|ImpersonateDomain}}
{{APIPrefix|As String}}
=
{{APIName|"",}}
{{APIPrefix|Optional ByVal}}
{{APIName|ImpersonateUsername}}
{{APIPrefix|As String}}
=
{{APIName|"",}}
{{APIPrefix|Optional ByVal}}
{{APIName|ImpersonatePassword}}
{{APIPrefix|As String}}
=
{{APIName|"")}}
{{APIPrefix|As Boolean}}<br>
{{APIComment|Connects to an MS SQL repository.}}


{{Template:ConnectToSQLRepository}}
== Parameters ==
'''ServerName'''
The server file path for the SQL Repository.
 
'''DatabaseName'''
The Database name of the Synthesis Repository to connect.
 
'''UseImpersonation'''
The database requires impersonation.
 
'''ImpersonateDomain'''
The domain for the impersonation.
 
'''ImpersonateUsername'''
The User Name for the impersonation.
 
'''ImpersonatePassword'''
The Password for the impersonation.
 
== Usage Example ==
 
{{APIComment|Declare a new repository connection class.}}
        Private WithEvents MyRepository As New Repository
 
{{APIComment|Connect to the Synthesis repository.}}
        Dim Success As Boolean = False
        Success = MyRepository.ConnectToSQLRepository("SQLServerPath", "SQLDatabaseName")

Revision as of 21:25, 17 September 2013



Property Syntax

Public Function ConnectToSQLRepository( ByVal ServerName As String, ByVal DatabaseName As String, Optional ByVal UseImpersonation As Boolean = False, Optional ByVal ImpersonateDomain As String = "", Optional ByVal ImpersonateUsername As String = "", Optional ByVal ImpersonatePassword As String = "") As Boolean
Connects to an MS SQL repository.

Parameters

ServerName The server file path for the SQL Repository.

DatabaseName The Database name of the Synthesis Repository to connect.

UseImpersonation The database requires impersonation.

ImpersonateDomain The domain for the impersonation.

ImpersonateUsername The User Name for the impersonation.

ImpersonatePassword The Password for the impersonation.

Usage Example

Declare a new repository connection class.

       Private WithEvents MyRepository As New Repository

Connect to the Synthesis repository.

       Dim Success As Boolean = False
       Success = MyRepository.ConnectToSQLRepository("SQLServerPath", "SQLDatabaseName")