OCI_odessp

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_odessp
     (  value OCI_Handle_type lda,
        value string objnam,
        value integer onlen,
        modifiable integer ovrld,
        modifiable integer pos,
        modifiable integer level,
        modifiable stream  argnam,
        modifiable integer arnlen,
        modifiable integer dtype,
        modifiable integer defsup,
        modifiable integer mode,
        modifiable integer dtsiz,
        modifiable integer prec,
        modifiable integer scale,
        modifiable integer radix,
        modifiable integer arrsiz
     )

Purpose

This function is used to describe the parameters of a PL/SQL procedure or function stored in an Oracle database. All of the variables used as output arguments in this function call must be declared as a variable size shelf, and each shelf is cleared in the function. Items are added to the output shelves, one for each stored procedure or function parameter.

Input arguments:

lda -- Login data area descriptor.
objnam -- The name of the procedure, including optional schema and package name.
onlen -- The length of objnam or OCI_NTS.

Output arguments:

ovrld -- An integer shelf containing the level of procedure overloading.
pos -- The integer shelf containing the position of the parameter in the procedure. Parameter positions start at one. The function return type is described at position zero.
level -- An integer shelf containing the level within the scalar, record, or array parameter.
argnam -- A stream shelf containing the parameter name in the function or procedure.
arnlen -- An integer shelf containing the lengths of the parameter name
dtype -- An integer shelf containing the Oracle datatype for each parameter.
defsup -- An integer shelf containing an indicator of whether the parameter has a default value.
mode -- An integer shelf containing the access mode of the parameter.
dtsiz -- An integer shelf containing the size of the datatype in bytes.
prec -- An integer shelf containing the precision for the parameter, if it is numeric. Otherwise, it returns a zero.
scale -- An integer shelf containing the scale of the parameter, if it is numeric.
radix -- An integer shelf containing the radix of the parameter, if it is numeric.

Input/output argument:

arrsiz -- On input, the maximum number of procedure or function parameters to return. On output, the number of procedure or function parameters returned.