Macros and Global Functions for OLE DB Consumer Templates

Visual Studio 2015

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at Macros and Global Functions for OLE DB Consumer Templates.

The OLE DB Consumer Templates include the following macros and global functions:

Global Functions


AtlTraceErrorRecords	Dumps OLE DB Error Record information to the dump device if an error is returned.

Accessor Map Macros


BEGIN_ACCESSOR	Marks the beginning of an accessor entry.
BEGIN_ACCESSOR_MAP	Marks the beginning of the accessor map entries.
END_ACCESSOR	Marks the end of an accessor entry.
END_ACCESSOR_MAP	Marks the end of the accessor map entries.

Column Map Macros


BEGIN_COLUMN_MAP	Marks the beginning of the column map entries in the user record class.
BLOB_ENTRY	Used to bind a binary large object (BLOB).
BLOB_ENTRY_LENGTH	Reports the length of the BLOB data column.
BLOB_ENTRY_LENGTH_STATUS	Reports the length and status of the BLOB data column.
BLOB_ENTRY_STATUS	Reports the status of the BLOB data column.
BLOB_NAME	Used to bind a binary large object by column name.
BLOB_NAME_LENGTH	Reports the length of the BLOB data column.
BLOB_NAME_LENGTH_STATUS	Reports the length and status of the BLOB data column.
BLOB_NAME_STATUS	Reports the status of the BLOB data column.
BOOKMARK_ENTRY	Represents a bookmark entry on the rowset. A bookmark entry is a special kind of column entry.
COLUMN_ENTRY	Represents a binding to a specific column in the database.
COLUMN_ENTRY_EX	Represents a binding to the specific column in the database. Supports `type`, length, precision, `scale`, and status parameters.
COLUMN_ENTRY_LENGTH	Represents a binding to the specific column in the database. Supports the length variable.
COLUMN_ENTRY_LENGTH_STATUS	Represents a binding to the specific column in the database. Supports status and length parameters.
COLUMN_ENTRY_PS	Represents a binding to the specific column in the database. Supports precision and `scale` parameters.
COLUMN_ENTRY_PS_LENGTH	Represents a binding to the specific column in the database. Supports the length variable, precision and `scale` parameters.
COLUMN_ENTRY_PS_LENGTH_STATUS	Represents a binding to the specific column in the database. Supports status and length variables, precision and `scale` parameters.
COLUMN_ENTRY_PS_STATUS	Represents a binding to the specific column in the database. Supports the status variable, precision and `scale` parameters.
COLUMN_ENTRY_STATUS	Represents a binding to the specific column in the database. Supports the status variable.
COLUMN_ENTRY_TYPE	Represents a binding to a specific column in the database. Supports `type` parameter.
COLUMN_ENTRY_TYPE_SIZE	Represents a binding to the specific column in the database. Supports `type` and `size` parameters.
COLUMN_NAME	Represents a binding to a specific column in the database by name.
COLUMN_NAME_EX	Represents a binding to a specific column in the database by name. Supports specification of data type, size, precision, scale, column length, and column status.
COLUMN_NAME_LENGTH	Represents a binding to a specific column in the database by name. Supports specification of column length.
COLUMN_NAME_LENGTH_STATUS	Represents a binding to a specific column in the database by name. Supports specification of column length and status.
COLUMN_NAME_PS	Represents a binding to a specific column in the database by name. Supports specification of precision and scale.
COLUMN_NAME_PS_LENGTH	Represents a binding to a specific column in the database by name. Supports specification of precision, scale, and column length.
COLUMN_NAME_PS_LENGTH_STATUS	Represents a binding to a specific column in the database by name. Supports specification of precision, scale, column length, and column status.
COLUMN_NAME_PS_STATUS	Represents a binding to a specific column in the database by name. Supports specification of precision, scale, and column status.
COLUMN_NAME_STATUS	Represents a binding to a specific column in the database by name. Supports specification of column status.
COLUMN_NAME_TYPE	Represents a binding to a specific column in the database by name. Supports specification of data type.
COLUMN_NAME_TYPE_PS	Represents a binding to a specific column in the database by name. Supports specification of data type, precision, and scale.
COLUMN_NAME_TYPE_SIZE	Represents a binding to a specific column in the database by name. Supports specification of data type and size.
COLUMN_NAME_TYPE_STATUS	Represents a binding to a specific column in the database by name. Supports specification of data type and column status.
END_COLUMN_MAP	Marks the end of the column map entries.

Command Macros


DEFINE_COMMAND	Specifies the command that will be used to create the rowset when using the CCommand class. Accepts only string types matching the specified application type (ANSI or Unicode). It is recommended that you use DEFINE_COMMAND_EX instead of `DEFINE_COMMAND`.
DEFINE_COMMAND_EX	Specifies the command that will be used to create the rowset when using the CCommand class. Supports ANSI and Unicode applications.

Parameter Map Macros


BEGIN_PARAM_MAP	Marks the beginning of the parameter map entries in the user record class.
END_PARAM_MAP	Marks the end of the parameter map entries.
SET_PARAM_TYPE	Specifies `COLUMN_ENTRY` macros that follow the `SET_PARAM_TYPE` macro as input, output, or input/output.