Repository.ConnectToSQLRepository: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
(Created page with '{{Template:APIClass|Repository Class|Repository}} == Declaration == {{APIPrefix|Public Function}} {{APIName|ConnectToAccessRepository(}} {{APIPrefix|ByVal}} {{APIName|FileName…')
 
No edit summary
 
(26 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}


== Declaration  ==


{{APIPrefix|Public Function}}
<onlyinclude>Connects to a SQL Server repository. Returns a '''Boolean''' value; when true, indicates a successful connection to the repository.</onlyinclude>
{{APIName|ConnectToAccessRepository(}}
{{APIPrefix|ByVal}}
{{APIName|FileName}}
{{APIPrefix|As String}}
{{APIName|)}}
{{APIPrefix|As Boolean}}
=
{{APIPrefix|False}}
{{APIName|,}}
{{APIPrefix|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}}


{{APIComment|Connects to an MS SQL repository.}}
== Syntax ==
'''.ConnectToSQLRepository'''(''ServerName'', ''DatabaseName'', ''UseImpersonation'', ''ImpersonateDomain'', ''ImpersonateUsername'', ''ImpersonatePassword'')
 
===Parameters===
''ServerName''
:Required. String. The name of the SQL Server.
 
''DatabaseName''
:Required. String. The name of the database.
 
''UseImpersonation''
:Optional. Boolean. Indicates whether the database requires impersonation. Default value = False.
 
''ImpersonateDomain''
:Optional. String. The domain for the impersonation.
 
''ImpersonateUsername''
:Optional. String. The account username for the impersonation.
 
''ImpersonatePassword''
:Optional. String. The account password for the impersonation.
 
 
==Example==
'''VB|VB.NET'''
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
MyRepository.ConnectToSQLRepository({{APIString|"MyServer"}}, {{APIString|"MyDatabase"}})

Latest revision as of 16:18, 17 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Connects to a SQL Server repository. Returns a Boolean value; when true, indicates a successful connection to the repository.

Syntax

.ConnectToSQLRepository(ServerName, DatabaseName, UseImpersonation, ImpersonateDomain, ImpersonateUsername, ImpersonatePassword)

Parameters

ServerName

Required. String. The name of the SQL Server.

DatabaseName

Required. String. The name of the database.

UseImpersonation

Optional. Boolean. Indicates whether the database requires impersonation. Default value = False.

ImpersonateDomain

Optional. String. The domain for the impersonation.

ImpersonateUsername

Optional. String. The account username for the impersonation.

ImpersonatePassword

Optional. String. The account password for the impersonation.


Example

VB|VB.NET

Dim MyRepository As New Repository
MyRepository.ConnectToSQLRepository("MyServer", "MyDatabase")