Retrieve information about a column generated by a browse-mode select.
CS_RETCODE ct_br_column(cmd, colnum, browsedesc) CS_COMMAND *cmd; CS_INT colnum; CS_BROWSEDESC *browsedesc;
A pointer to the CS_COMMAND structure managing a client/server operation.
The number of the column to describe. The first column in a select statement’s select-list is column number 1, the second is number 2, and so forth.
A pointer to a CS_BROWSEDESC structure. ct_br_column fills this structure with information about the column specified by colnum.
For information about the CS_BROWSEDESC structure, see “CS_BROWSEDESC structure”.
ct_br_column returns the following values:
Return value |
Meaning |
|---|---|
CS_SUCCEED |
The routine completed successfully. |
CS_FAIL |
The routine failed. |
CS_BUSY |
An asynchronous operation is already pending for this connection. For more information, see “Asynchronous programming”. |
ct_br_column fails if the current result set was not generated by a select...for browse language command.
ct_br_column fills *browsedesc with information about the column specified by colnum.
A column can be updated through browse mode only if it:
Belongs to a browsable table,
Is the result of a select...for browse, and
Is not the result of a SQL expression, such as max(colname).
Is an error to call ct_br_column if browse-mode information is not available. Generally, browse mode information is available if the current result set is a CS_ROW_RESULT result set that was generated by a select...for browse.
Before calling ct_br_column, an application can call ct_res_info with type as CS_BROWSE_INFO to check whether browse mode information is available.
