Full text search
function	OCI_odessp

Library: OCI Include: omoci.xin

Returns: Numeric Returns OCI_SUCCESS if the function completes without error.

Declaration

  define external counter function OCI_odessp
       (  value OCI_Handle_type lda,
          value stream objnam,
          value counter onlen,
          modifiable counter ovrld,
          modifiable counter pos,
          modifiable counter level,
          modifiable stream  argnam,
          modifiable counter arnlen,
          modifiable counter dtype,
          modifiable counter defsup,
          modifiable counter mode,
          modifiable counter dtsiz,
          modifiable counter prec,
          modifiable counter scale,
          modifiable counter radix,
          modifiable counter arrsiz
       )

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 -- A counter shelf containing the level of procedure overloading.
• pos -- The counter 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 -- A counter 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 -- A counter shelf containing the lengths of the parameter name
• dtype -- A counter shelf containing the Oracle datatype for each parameter.
• defsup -- A counter shelf containing an indicator of whether the parameter has a default value.
• mode -- A counter shelf containing the access mode of the parameter.
• dtsiz -- A counter shelf containing the size of the datatype in bytes.
• prec -- A counter shelf containing the precision for the parameter, if it is numeric. Otherwise, it returns a zero.
• scale -- A counter shelf containing the scale of the parameter, if it is numeric.
• radix -- A counter 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.