DataDirect OpenAccess SDK Help

dam_describeColDetail

Save PDF

dam_describeColDetail

Save PDF

Last Updated: May 12, 2026
2 minute read

OpenAccess SDK
Version 8.1
Documentation

This function is used to retrieve the details of the specified column. Pass in NULL for any attributes you do not want. The IP uses this function to:

Retrieve data type details - get the scale, precision, radix, length and other attributes associated with a column.
Retrieve user data - get the user data that is optionally stored for each column in the schema.

void dam_describeColDetail(
    DAM_HCOL       hcol, 
    sql_xo_type ** ppXoType, 
    int *          piPseudoColumn, 
    int *          piColumnType,
    char *         pUserData)

void dam_describeColDetailW(
    DAM_HCOL       hcol, 
    sql_xo_type ** ppXoType, 
    int *          piPseudoColumn, 
    int *          piColumnType,
    OAWCHAR *      pUserData)

Parameters for dam_describeColDetail

Parameter	Type	Description
IN
hcol	DAM_HCOL	The column handle.
OUT
ppXoType	sql_xo_type **	The pointer to the structure detailing the precision, scale, length, radix, null attributes of the column as defined in the schema. See sql_xo_type.
piPseudoColumn	int *	Indicates if the column is marked as a PSEUDO column in which case the user is not allowed to insert or update its value. The output is one of the following: SQL_PC_UNKNOWN - not set SQL_PC_NOT_PSEUDO - the column is not a PSEUDO column and should be treated like a normal user column. SQL_PC_PSEUDO - the column is a PSEUDO column if a column is a pseudo column.
piColumnType	int *	If the column has been marked as a SQL_PC_PSEUDO to indicate it is a pseudo column, then this field indicates whether it is a ROWID or ROWVER. DAM_NOT_SET - if column is not a pseudo column. SQL_BEST_ROWID - the column is used to uniquely identify the row. SQL_ROWVER - the column is used to track the version of the row.
pUserData	char * OAWCHAR *	User data as specified in the schema.
RETURN
	NONE