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

Return type: Integer 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
     )

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
     )

Other Library Functions    OCI_Array_type    OCI_GetArrayAsCounter    OCI_GetArrayAsCounterShelf    OCI_GetArrayAsStream    OCI_GetArrayAsStreamShelf    OCI_GetArrayAsString    OCI_GetArrayElementCount    OCI_GetArrayElementLen    OCI_GetErrorCode    OCI_Handle_type    OCI_HostData_type    OCI_IsVersionCompatible    OCI_LibraryVersion    OCI_obindps    OCI_obndra    OCI_obndrn    OCI_obndrv    OCI_ocan    OCI_oclose    OCI_ocof    OCI_ocom    OCI_ocon    OCI_odefin    OCI_odefinps    OCI_odescr    OCI_odessp    OCI_oerhms    OCI_oexec    OCI_oexfet    OCI_oexn    OCI_ofen    OCI_ofetch    OCI_oflng    OCI_ogetpi    OCI_olog    OCI_ologof    OCI_onbclr    OCI_onbset    OCI_onbtst    OCI_oopen    OCI_oopt    OCI_oparse    OCI_orol    OCI_osetpi    OCI_SetArrayAsCounter    OCI_SetArrayAsCounterShelf    OCI_SetArrayAsStream    OCI_SetArrayAsStreamShelf    OCI_SetArrayAsString    OCI_SetArraySize

[ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACYLIBRARIES ] [ ERRORS ]