OCI_odescr

function

Library: Oracle Call Interface database support (OMOCI legacy)
Include: omoci.xin

Returns: Returns OCI_SUCCESS if the function completes without error.

Declaration

define external integer function OCI_odescr
   (  value OCI_Handle_type cursor,
      value integer pos,
      modifiable integer dbsize,
      modifiable integer dbtype,
      modifiable stream cbuf,
      modifiable integer cbufl,
      modifiable integer dsize,
      modifiable integer prec,
      modifiable integer scale,
      modifiable integer nullok
   )

Purpose

This function describes select-list items for SQL queries. The function returns internal datatype and size information for a specified select-list item.

Input arguments:

cursor -- Cursor data area descriptor.
pos -- The index position of the data column in the row. The first column is position 1.

Output arguments:

dbsize -- The maximum size of the column.
dbtype -- The internal datatype of the select-list item.
cbuf -- The name of the select-list item.
dsize -- The maximum display size of a character string select-list item.
prec -- The precision of numeric select-list items.
nullok -- Returns OCI_NULLABLE if null values are permitted in the column.

Input/output argument:

cbufl - The maximum name length, on input, and the returned length of the item name on return.

Example:

  set RetCode to OCI_odescr
     (  Cursor,
        1,
        Desc@1,
        Desc@2,
        ColName,
        ColNameLen,
        Desc@3,
        Desc@4,
        Desc@5,
        Desc@6
     )