AppInstance.TryGetAppDatabaseConnectionDirect method (ClientRuntimeContext, SqlConnectionStringBuilder, SqlConnection, Boolean)

Retrieves a connection to the app database.

Namespace:  Microsoft.SharePoint.Client
Assembly:  Microsoft.SharePoint.Client (in Microsoft.SharePoint.Client.dll)

Syntax

'Declaration
Public Shared Function TryGetAppDatabaseConnectionDirect ( _
    context As ClientRuntimeContext, _
    template As SqlConnectionStringBuilder, _
    <OutAttribute> ByRef connection As SqlConnection, _
    <OutAttribute> ByRef isReadOnly As Boolean _
) As Boolean
'Usage
Dim context As ClientRuntimeContext
Dim template As SqlConnectionStringBuilder
Dim connection As SqlConnection
Dim isReadOnly As Boolean
Dim returnValue As Boolean

returnValue = AppInstance.TryGetAppDatabaseConnectionDirect(context, _
    template, connection, isReadOnly)

public static bool TryGetAppDatabaseConnectionDirect(
    ClientRuntimeContext context,
    SqlConnectionStringBuilder template,
    out SqlConnection connection,
    out bool isReadOnly
)

Parameters

• context
  Type: Microsoft.SharePoint.Client.ClientRuntimeContext

  Client context to operate with.

• template
  Type: System.Data.SqlClient.SqlConnectionStringBuilder

  SQL conenction build to be used as a template when creating the connection.

• connection
  Type: System.Data.SqlClient.SqlConnection

  Connection object if one could be opened, otherwise a null reference (Nothing in Visual Basic).

• isReadOnly
  Type: System.Boolean

  Indicates whether the connection can be used to write data. true if the connection can be used to write data, otherwise false.

Return value

Type: System.Boolean
true if a connection can be opened, otherwise false.

Remarks

This method only returns connections to the database that are auto deployed. This method may call ExecuteQuery function on the given context.

See also

Reference

AppInstance class

AppInstance members

TryGetAppDatabaseConnectionDirect overload

Microsoft.SharePoint.Client namespace