ct_br_column

Description

Retrieve information about a column generated by a browse-mode select.

Syntax

CS_RETCODE ct_br_column(cmd, colnum, browsedesc)
 
 CS_COMMAND           *cmd;
 CS_INT                         colnum;
 CS_BROWSEDESC      *browsedesc;

Parameters

cmd

A pointer to the CS_COMMAND structure managing a client/server operation.

colnum

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.

browsedesc

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”.

Returns

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.

Usage

See also

“Browse mode”, ct_br_table