Share via

5 Appendix A: Product Behavior

  • Article

The information in this specification is applicable to the following Microsoft products or supplemental software. References to product versions include updates to those products.

  • 2007 Microsoft Office system

  • Microsoft Office 2010 system

  • Microsoft Office 2013 system

  • Microsoft Office 2016

  • Microsoft Office 2019

  • Microsoft Office 2021

  • Microsoft SQL Server 2005

  • Microsoft SQL Server 2008

  • Microsoft SQL Server 2008 R2

  • Microsoft SQL Server 2012

  • Microsoft SQL Server 2014

  • Microsoft SQL Server 2016

  • Microsoft SQL Server 2017

  • Microsoft SQL Server 2019

  • Microsoft SQL Server 2022

  • Windows Vista operating system

  • Windows Server 2008 operating system

  • Windows 7 operating system

  • Windows Server 2008 R2 operating system

  • Windows 8 operating system

  • Windows Server 2012 operating system

  • Windows 8.1 operating system

  • Windows Server 2012 R2 operating system

  • Windows 10 operating system

  • Windows Server 2016 operating system

  • Windows Server operating system

  • Windows Server 2019 operating system

  • Windows Server 2022 operating system

  • Windows 11 operating system

  • Windows Server 2025 operating system

Exceptions, if any, are noted in this section. If an update version, service pack or Knowledge Base (KB) number appears with a product name, the behavior changed in that update. The new behavior also applies to subsequent updates unless otherwise specified. If a product edition appears with the product version, behavior is different in that product edition.

Unless otherwise specified, any statement of optional behavior in this specification that is prescribed using the terms "SHOULD" or "SHOULD NOT" implies product behavior in accordance with the SHOULD or SHOULD NOT prescription. Unless otherwise specified, the term "MAY" implies that the product does not follow the prescription.

<1> Section 2.3: The following table specifies the generic keys that are supported by Microsoft OLE DB Provider for SQL Server (SQLOLEDB). For more information about SQLOLEDB, see [MSDN-SQLOLEDB].

Key

Microsoft OLE DB Provider for SQL Server requirements

General Timeout

The valid values are unsigned integers that range from greater than or equal to 0 to less than or equal to 65534. A value of 0 specifies an infinite time-out. The default value is 0.

Window Handle

This key does not have a default value.

Integrated Security

The valid values are "SSPI" or an empty string. The default value is an empty string. The value "SSPI" specifies that Security Support Provider Interface [SSPI] is used as the Authentication Service (AS) for this connection.

Locale Identifier

The language code identifier (LCID) that is specified is supported by the operating system on which the data source object resides.

Password

This key does not have a default value.

Persist Security Info

If the value of this key is "true", the provider persists the value of the Password key if requested to persist the connection information. If the value of this key is "false", the provider does not persist the value of the Password key.

User ID

This key is the SQL Server login name. This key does not have a default value.

Prompt

The default value is "NoPrompt".

Initial Catalog

If a value for this key is not specified in the connection string, the provider opens the user's default database on the data source by default. For more information about default databases, see [MSDN-SD].

Data Source

This key is the name of the SQL Server instance to which to connect. If a value for this key is not specified in the connection string, the provider connects to the database server on the same computer that is hosting the data source object by default.

Connect Timeout

The valid values are unsigned integers that range from greater than or equal to 0 to less than or equal to 65534. A value of 0 specifies an infinite time out. If a value for this key is not specified in the connection string, a connection fails if the login time exceeds 15 seconds.

Extended Properties

The provider accepts an ODBC connection string as specified in [MS-ODBCSTR]. This key does not have a default value.

The following table specifies the generic keys that are supported by the Microsoft OLE DB Provider for SQL Server (SQLOLEDB) in Microsoft SQL Server Analysis Services. For more information about Analysis Services, see [MS-SSAS].

Key

Microsoft OLE DB Provider for SQL Server Analysis Services requirements

General Timeout

The valid values are unsigned integers that range from greater than or equal to 0 to less than or equal to 65534. A value of 0 specifies an infinite time-out. The default value is 0.

Window Handle

This key does not have a default value.

Integrated Security

The valid values are "SSPI" or an empty string. The default value is "SSPI". The value "SSPI" specifies that Security Support Provider Interface [SSPI] is used as the Authentication Service (AS) for this connection.

Locale Identifier

The language code identifier (LCID) that is specified is supported by the operating system on which the data source object resides.

Password

This key does not have a default value.

Persist Security Info

If the value of this key is "true", the provider persists the value of the Password key if requested to persist the connection information. If the value of this key is "false", the provider does not persist the value of the Password key.

User ID

This key does not have a default value.

Prompt

The default value is "NoPrompt".

Initial Catalog

If a value for this key is not specified in the connection string, the provider can default to any database on the data source.

Data Source

This key is the name of the SQL Server Analysis Services instance to which to connect. The value for this key is specified.

Connect Timeout

The valid values are unsigned integers that range from greater than or equal to 0 to less than or equal to 65534. A value of 0 specifies an infinite time-out. The default value is 60 seconds.

Impersonation Level

The default value is "Impersonate".

Protection Level

The supported values are "None", "Connect", "Pkt Integrity" and "Pkt Privacy". The "Call" and "Pkt" values are not supported. The default value is "Pkt Privacy".

<2> Section 2.3: In an implementation that uses Microsoft OLE DB Provider for Microsoft SQL Server (SQLOLEDB), the connection string is an OleDBConnectionString that allows the following additional provider-specific keys.

Key

Meaning

Application Name

Specifies the name of the OLE DB consumer. This key does not have a default value.

Auto Translate

Specifies whether the OLE DB consumer requests the provider to convert OEM characters or ANSI characters between the code page of the OLE DB consumer and the code page of the database when characters are retrieved from or sent to the database. The valid values are "true" and "false." The default value is "true".

Current Language

Specifies the language that is used for database message selection and formatting. This key does not have a default value.

Network Address

Specifies the network address of an instance of the database server. If the value of the Network Address key is not specified, the default value is the value of the Data Source key. If the value of the Data Source key contains an instance name, the instance name that is contained in the value of the Data Source key is appended to the value of the Network Address key. For more information about instance names, see [MSDN-UNI].

The network address has to be in TCP format or NP format.

  • TCP format

    tcp:<host name>\<instance name>

    tcp:<host name>,<TCP/IP port number>

    TCP format has to start with the prefix "tcp:" and is followed by the database instance, specified by a <host name> and an <instance name>.

    The <host name> has to be specified in one of three ways:

    The <instance name> is used to resolve to a particular TCP/IP port number [RFC793] on which a database instance is hosted. Alternatively, a <TCP/IP port number> can be specified directly. If both <instance name> and <port number> are not present, the default database instance is used.

    • NP format

      np:\\<host name>\pipe\<pipe name>

      NP format has to start with the prefix "np:" and is followed by a named pipe name.

      The <host name> has to be specified in one of three ways:

      • NetBIOSName [RFC1002]

      • IPv4Address [RFC791]

      • IPv6Address [RFC2460].

      The <pipe name> is used to identify the database instance to which to be connected.

Only when the value of the Network key is specified as "DBNETLIB" can the protocol prefixes "tcp:" and "np:" be used. If any other value of the Network Library key is specified, the prefixes "tcp:" and "np:" cannot be used.

For more information about the format of the Network Address key, see [MSKB-313295].

For more information about named pipes, see [MSDN-NP].

Network Library

This key is the name of the network component that is used to communicate with the database server.

For Microsoft implementations, the values and their behaviors for the various components are described here.

  • DBNMPNTW – This component implements the named pipes protocol [MSDN-NP].

  • DBMSSOCN – This component implements the TCP/IP protocol.

  • DBMSSPXN – This component implements the NWLink IPX/SPX protocol.

  • DBMSRPCN – This component implements the Multi-Protocol protocol.

  • DBMSVINN – This component implements the Banyan Vines protocol.

  • DBMSADSN – This component implements the ADSP protocol.

  • DBMSSHRN – This component implements the Shared Memory protocol.

  • DBMSLPCN – This component implements the Shared Memory protocol.

  • DBNETLIB – The default search order of network component can be used.

This key does not have a default value. If the value that is specified is not listed above or if the Network key is not specified, the default search order of network component can be used. For more information about the default search order of network component, see [MSKB-328383].

Packet Size

Sets the network packet size in bytes (as specified by the PacketSize field in section 2.2.6.4 of [MS-TDS]) to be used for data exchange between the data source object and the database. The valid values are unsigned integers that range from greater than or equal to 512 to less than or equal to 32767. The default packet size is 4096 bytes.

Use Procedure for Prepare

Specifies that the OLE DB consumer requests a temporary stored procedure to be created on the database when a command is prepared. The valid values are the following:

"1": A temporary stored procedure is created when a command is prepared. All temporary stored procedures are dropped when the session is released.

"2": A temporary stored procedure is created when a command is prepared. The procedure is dropped when the command is unprepared, when a new command is specified, or when all application references to the command are released.

The default value is "1".

Workstation ID

Sets the workstation identifier as specified by the ibHostName and cchHostName fields in section 2.2.6.4 of [MS-TDS]. The default value is the name of the workstation that is running the OLE DB consumer.

Initial File Name

Sets the name of the primary file of an attachable database as specified by the ibAtchDBFile and cchAtchDBFile fields in section 2.2.6.4 of [MS-TDS]. This key does not have a default value. For more information about attachable databases, see [MSDN-DAD]. If a value for this key is specified, a value for the Initial Catalog key also has to be specified.

Use Encryption for Data

Specifies whether data ought to be encrypted before sending it over the network. The valid values are "true" and "false". The default value is "false".

Replication server name connect option

Sets the server name (as specified by the ibServerName and cchServerName fields in section 2.2.6.4 of [MS-TDS]) and replication login type (as specified by the fUserType field in section 2.2.6.4 of [MS-TDS]) that the OLE DB consumer requests to send to the database server.

Tag with column collation when possible

Specifies whether the OLE DB consumer requests that data be tagged with collation information that is obtained from the database server instead of from the code page on the provider. The valid values are "true" and "false". The default value is "false".

In the Analysis Services implementation that uses SQLOLEDB, the connection string is an OleDBConnectionString that allows the following additional provider-specific keys. For more information about Analysis Services, see [MS-SSAS].

Key

Meaning

SSPI

Specifies the type of Security Support Provider Interface that is requested by the OLE DB consumer. The valid values are the following:

The default value is "Negotiate".

Protocol Format

Specifies the OLE DB consumer-requested encoding format for XML messages on this connection. The valid values are the following:

  • "Default": Binary encoding

  • "XML": Text encoding

  • "Binary": Binary encoding

Transport Compression

Specifies whether the OLE DB consumer requests messages on this connection to be compressed. The valid values are the following:

  • "Default": Messages are compressed.

  • "None": Messages are not compressed.

  • "Compressed": Messages are compressed.

Compression Level

Specifies the OLE DB consumer-requested level of compression when the value of the Transport Compression key is "Compressed". A value of "0" specifies minimum compression, and a value of "9" specifies maximum compression. The valid values are integers that range from greater than or equal to 0 to less than or equal to 9.

When the value of the Transport Compression key is not "Compressed", the value of the Compression Level key has to be ignored if present.

SessionID

Specifies the ID of the session to use in this connection. When a value for the SessionID key is not specified, a new session is created for the duration of this connection.

Auto Synch Period

Specifies the OLE DB consumer-requested frequency, in milliseconds, of synchronization between the OLE DB provider and the server. The default frequency is 10000 milliseconds.

<3> Section 2.3: In Microsoft implementations, when the Provider key is not specified in a connection string, OLE DB services (for more information, see [MSDN-ODBS]) uses the following default values:

  • "MSDASQL" on 32-bit operating systems, including Microsoft Windows-32-bit-On-Windows-64-bit (WOW64).

  • "SQLOLEDB" on 64-bit operating systems.

<4> Section 2.3: In Microsoft implementations, when a value is specified for the Integrated Security key, the values of the following keys are ignored if present: Cache Authentication, Encrypt Password, Mask Password, Password, Persist Encrypted, Persist Security Info, and User ID.

<5> Section 2.3: In Microsoft implementations, when the value of the Persist Security Info key is "false", the value of the Persist Encrypted key is ignored if present.

<6> Section 2.3: In Microsoft implementations, the initialization process returns immediately, but the actual initialization of the data source object is performed asynchronously. If the "Initialize" value is not specified, the data source object is initialized synchronously.

<7> Section 2.3: In Microsoft implementations, the OLE DB provider can use the value of the Data Source key together with the value of the Location key to determine the location of the data source.

<8> Section 2.3: In Microsoft implementations, using the Locale Identifier key does not guarantee that all text that is returned to the consumer will be translated according to the language code identifier (LCID).

<9> Section 2.3: In Microsoft implementations, the OLE DB provider can use the value of the Location key together with the value of the Data Source key to determine the location of the data source.

<10> Section 2.3: In Microsoft implementations, when the "ClientCursor" value is part of the compound value for the OLE DB Services key, the "AgrAfterSession" value is ignored if present.