Repository.ConnectToSQLRepository: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|9|Repository}}</noinclude>
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
 
 
<onlyinclude>Connects to a SQL Server repository. Returns a '''Boolean''' value; when true, indicates a successful connection to the repository.</onlyinclude>  


Connects to a SQL server repository that you specify. Returns a '''Boolean''' value; when true, indicates a successful connection to the repository.
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''ConnectToSQLRepository(''ServerName'', ''DatabaseName'', ''UseImpersonation'', ''ImpersonateDomain'', ''ImpersonateUsername'', ''ImpersonatePassword'')'''
'''.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.


where ''object'' is a variable that represents a Repository object.
''ImpersonateUsername''
:Optional. String. The account username for the impersonation.


===Parameters===
''ImpersonatePassword''
{| {{APITable}}
:Optional. String. The account password for the impersonation.
|-
|ServerName{{APIParam|Required}}||'''String'''. The server file path for the SQL database.
|-
|DatabaseName{{APIParam|Required}}||'''String'''. The name of the database.
|-
|UseImpersonation{{APIParam|Optional}}||'''Boolean'''. When true, indicates that the database requires SQL impersonation. Default value is false.
|-
|ImpersonateDomain{{APIParam|Optional}}||'''String'''. The domain for the impersonation.
|-
|ImpersonateUsername{{APIParam|Optional}}||'''String'''. The account username for the impersonation.
|-
|ImpersonatePassword{{APIParam|Optional}}||'''String'''. The account password for the impersonation.
|}




==Example==
==Example==
This example assumes that a SQL database named "MyEnterprise" exists in the C: drive. This code sample ignores the return value.
  '''VB|VB.NET'''
  '''VB|VB.NET'''<br>
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToSQLRepository({{APIString|"C:\Program Files\Microsoft SQL Server\"}}, {{APIString|"MyEnterprise"}})
  MyRepository.ConnectToSQLRepository({{APIString|"MyServer"}}, {{APIString|"MyDatabase"}})
</noinclude>

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")
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.ConnectToSQLRepository&oldid=64347"