'Declaration Public Shadows Property ConnectionString As String
public new string ConnectionString {get; set;}
'Declaration Public Shadows Property ConnectionString As String
public new string ConnectionString {get; set;}
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 |
---|---|
Client Id | One of the pair of OAuth 2.0 credentials, that you can obtain when you register a client application at developer.intuit.com/myapps with your developer account. |
Client Secret | The second one of the pair of OAuth 2.0 credentials, that you can obtain when you register a client application at developer.intuit.com/myapps with your developer account. |
Company Id | The string that uniquely identifies a QuickBooks company. |
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. |
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 QuickBooksConnection 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 | QuickBooks OAuth 2.0 refresh token. |
Token Server | The location to store OAuth 2.0 refresh tokens between sessions. Can be a file on disk or a registry key. For example, "Token Server=file://D:\\temp\\QuickBooks_oauth_token_1234.txt" or "Token Server=reg://HKEY_CURRENT_USER\\Software\\Devart\\QuickBooks\\OAuth_12345". |
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. |
public void CreateQuickBooksConnection() { string myConnString1 = "Company Id=1440905870;Refresh Token=AB11590759756UCO8O6CpRQcAMP00sIANafgS8Y4RN10rpLJNM;Token Server=file://D:\\temp\\QuickBooksToken.txt"; QuickBooksConnection quickBooksConnection1 = new QuickBooksConnection(myConnString1); quickBooksConnection1.Open(); }
Public Sub CreateQuickBooksConnection() Dim myConnString1 As String = _ "Company Id=1440905870;Refresh Token=AB11590759756UCO8O6CpRQcAMP00sIANafgS8Y4RN10rpLJNM;Token Server=file://D:\\temp\\QuickBooksToken.txt" Dim quickBooksConnection1 As New QuickBooksConnection(myConnString1) quickBooksConnection1.Open() End Sub
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