ODBCConnection Properties (Excel)

GitHub-Mark-64px

Contribute to this content

Use GitHub to suggest and submit changes. See our guidelines for contributing to VBA documentation.

Properties

Name

Description

AlwaysUseConnectionFile

True if the connection file is always used to establish connection to the data source. Read/write Boolean.

Application

When used without an object qualifier, this property returns an Application object that represents the Microsoft Excel application. When used with an object qualifier, this property returns an Application object that represents the creator of the specified object. Read-only.

BackgroundQuery

True if queries for the ODBC connection are performed asynchronously (in the background). Read/write Boolean.

CommandText

Returns or sets the command string for the specified data source. Read/write Variant.

CommandType

Returns or sets one of the XlCmdType constants. Read/write XlCmdType.

Connection

Returns or sets a string that contains ODBC settings that enable Microsoft Excel to connect to an ODBC data source. Read/write Variant.

Creator

Returns a 32-bit integer that indicates the application in which this object was created. Read-only Long.

EnableRefresh

True if the connection can be refreshed by the user. The default value is True. Read/write Boolean.

Parent

Returns the parent object for the specified object. Read-only.

RefreshDate

Returns the date on which the ODBC connection was last refreshed. Read-only Date.

Refreshing

True if a background ODBC query is in progress for the specified ODBC connection. Read/write Boolean.

RefreshOnFileOpen

True if the connection is automatically updated each time the workbook is opened. The default value is False. Read/write Boolean.

RefreshPeriod

Returns or sets the number of minutes between refreshes. Read/write Long.

RobustConnect

Returns or sets how ODBC connection connects to its data source. Read/write XlRobustConnect.

SavePassword

True if password information in an ODBC connection string is saved in the connection string. False if the password is removed. Read/write Boolean.

ServerCredentialsMethod

Returns or sets the type of credentials that should be used for server authentication. Read/write XlCredentialsMethod.

ServerSSOApplicationID

Returns or sets a single sign-on application (SSO) identifier that is used to do a lookup in the SSO database for credentials. Read/write String.

SourceConnectionFile

Returns or sets a String indicating the Microsoft Office Data Connection file or similar file that was used to create the connection. Read/write.

SourceData

Returns the data source for the ODBC connection, as shown in the table. Read/write Variant.

SourceDataFile

Returns or sets a String indicating the source data file for an ODBC connection. Read/write.