skip to main content
OpenAccess SDK SQL Engine core methods for .NET : Methods for .NET reference : dam_describeColDetail
 

dam_describeColDetail

This method is used to retrieve the details of the specified column. Pass in NULL for any attributes that you do not want. The IP uses this method to:
• Retrieve data type details – get the exact 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.
xo_type dam_describeColDetail(
int64 hcol,
out int piPseudoColumn,
out int piColumnType,
out int piSortOrder,
out int piFunctionType,
out int piIndexType,
StringBuilder pUserData)
 
Table 104: Parameters for dam_describeColDetail 
Parameter
Type
Description
IN
 
 
hcol
int64
The column handle
OUT
 
 
piPseudoColumn
out int
Indicates whether the column is marked as a pseudo column in which case the user is not allowed to insert or update its value. The output will be 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.
piColumnType
out 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
StringBuilder
User data as specified in the schema. Create and pass in a StringBuilder of DAM_MAX_ID_LEN+1.
RETURN
 
 
 
xo_type
Object of type xo_type detailing the precision, scale, length, radix, null attributes of the column as defined in the schema. See the following section for the xo_type definition.