GetColumnHeaderEx()


" "

short GetColumnHeaderEx(long QueryID, short Index)

Description

This function retrieves the column header (column name) associated with the parameter Index. After calling this function, the Value property can be interrogated for the returned value.

Parameters

Name Description
QueryID The ID of the query, as returned from InitializeQuery().
Index

The zero-based index of the column header to be retrieved.

Note:
Column headings are not available for static SQL statements. For query IDs returned from InitializeStaticQuery(), GetColumnHeaderEx() returns a string of the form "Coln" where "n" is the column number.

Return Value

The return value will be zero, if successful and non-zero if unsuccessful. If the return value is zero, query the Value property for the string representing the column name. If the return value is non-zero, you can call GetLastErrorString(), GetLastErrorType(), GetLastSQLCode(), GetLastSQLError(), or GetLastSQLState() to get additional error information.

Related Tasks

GetColumnHeader()
GetColumnHeadings()