SqlCursorColInfo%

Returns information about the specified column of a client cursor, transparent server cursor, or explicit server cursor.

Syntax

SqlCursorColInfo% ( cursorhandle%, column%, colname$, coltype%, collen&, usertype% )

where

cursorhandle%

Is the cursor handle created by SqlCursorOpen%.

column%

Is the column number in the cursor for which information is to be returned. The first column is number 1.

colname$

Is a string that will contain the name of the column. The program variable should be large enough to accommodate the column name.

coltype%

Is a program variable that will contain the datatype token of the column. If coltype% is set to -1, the column datatype is not returned.

collen&

Is a program variable that will contain the maximum length of the column, in bytes. If collen& is set to -1, the maximum column length is not returned.

usertype%

Is a program variable that will contain the user-defined datatype of the column. If usertype% is set to -1, the column user-defined datatype is not returned.

Returns

SUCCEED (1) or FAIL (0).

Remarks

Call SqlCursorColInfo% after SqlCursorOpen% returns a valid cursor handle. The SqlColInfo% function returns more detailed information about a cursor column.

See Also

SqlColInfo%, SqlCursor%, SqlCursorClose, SqlCursorFetch%, SqlCursorInfo%, SqlCursorOpen%