dotConnect for Dynamics 365 Documentation
Devart.Data.Dynamics Namespace / DynamicsConnection Class / ConnectionString Property
Example

ConnectionString Property (DynamicsConnection)
Gets or sets the string used to open a Dynamics 365 connection.
Syntax
'Declaration
 
Public Shadows Property ConnectionString As String
 

Property Value

The connection string that includes the parameters needed to establish the initial connection. The default value is an empty string ("").
Remarks
When ConnectionString property is assigned a value, connection closes. Many of the connection string values have corresponding properties. When the connection string is set, all of these properties are updated, except when an error is detected. In this case, none of the properties are updated. DynamicsConnection properties return only those settings contained in the ConnectionString.

Resetting the ConnectionString on a closed connection resets all connection string values (and related properties).

The connection string is parsed immediately after being set. If errors in syntax are found when parsing, a runtime exception, such as System.ArgumentException, is generated. Other errors can be found only when an attempt is made to Open the connection.

The ConnectionString is similar to an OLE DB connection string. Values may be delimited by single or double quotes, (for example, name='value' or name="value"). Either single or double quotes may be used within a connection string by using the other delimiter, for example, name="value's" or name= 'value"s', but not name= 'value's' or name= ""value"". All blank characters, except those placed within a value or within quotes, are ignored. Keyword value pairs must be separated by a semicolon (;). If a semicolon is part of a value, it also must be delimited by quotes. No escape sequences are supported. The value type is irrelevant. Names are not case sensitive. Arguments names may occur only once in the connection string.

The following table lists the valid names for values within the ConnectionString.

Name Description
Authentication Type Determines the authentication method to use. The following kinds are supported: RefreshToken and UsernamePassword. See AuthenticationType for more information.
Client Id One of the pair of OAuth 2.0 credentials, that you can obtain when you register an OAuth 2.0 application in your Azure AD tenant.
Client Secret The second one of the pair of OAuth 2.0 credentials, that you can obtain when you register an OAuth 2.0 application in your Azure AD tenant.
Connection Lifetime When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span (in seconds) exceeds the value specified by Connection Lifetime. The default value is 0 (connection always returns to pool).
Connect Timeout -or- Connection Timeout The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. The default value is 15.
Default Command Timeout The time in seconds to wait while trying to execute a command before terminating the attempt and generating an error. A value of 0 indicates no limit.
Initialization Command Specifies a data source-specific command that should be executed immediately after establishing the connection.
Max Pool Size The maximum number of connections allowed in the pool. Setting the Max Pool Size value of the ConnectionString can affect performance. The default value is 100.
Min Pool Size The minimum number of connections allowed in the pool. The default value is 0.
Password The password for UserNamePassword authentication.
Persist Security Info Indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.
Pooling If true, by default, the DynamicsConnection object is drawn from the appropriate pool or is created and added to the appropriate pool.
Proxy Host The host name or IP address of proxy server.
Proxy Password The password for the proxy server account.
Proxy Port The port number of the proxy server. The default value is 3128.
Proxy User The proxy server account name.
Run Once Command A command to execute when the connection is opened the first time and not executed when the connection is taken from the pool.
Readonly Determines whether the connection is read-only (allows only SELECT statements).
Refresh Token OAuth 2.0 refresh token, used for RefreshToken authentication.
Server The login URL to Dynamics CRM service.
Token Server The path to a file to store the refresh token between sessions. Used for RefreshToken authentication. This parameter is specified automatically when performing web login, and in most cases there is no need to modify it. If you want, you can specify a custom path to use instead of the default one.
User Id The Dynamics CRM login account. Required for UserNamePassword authentication.
UTC Dates Indicates whether all the datetime values retrieved from the data source are returned as UTC values or converted to local time, and whether date values, specified on the application side (for example, in SQL statements) are considered UTC or local. Default value is false.
Example
The following example creates a DynamicsConnection and sets some of its properties in the connection string.
public void CreateDynamicsConnection()
{
  string myConnString1 = 
     "Server=https://your_company.crm4.dynamics.com;User Id=Test@Test.onmicrosoft.com;Password=A123456789;";
  DynamicsConnection dynamicsConnection1 = new DynamicsConnection(myConnString1);
  dynamicsConnection1.Open();
}
Public Sub CreateDynamicsConnection()
  Dim myConnString1 As String = _
      "Server=https://your_company.crm4.dynamics.com;User Id=Test@Test.onmicrosoft.com;Password=A123456789;"
  Dim dynamicsConnection1 As New DynamicsConnection(myConnString1)
  dynamicsConnection1.Open()
End Sub
Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also