OCINumberToInt()

Purpose

Converts an Oracle number type to integer.

Syntax

sword OCINumberToInt ( OCIError              *err,
                       CONST OCINumber       *number,
                       uword                 rsl_length,
                       uword                 rsl_flag, 
                       dvoid                 *rsl );

Parameters

err (IN/OUT)

The OCI error handle. If there is an error, it is recorded in err and this function returns OCI_ERROR. Obtain diagnostic information by calling OCIErrorGet().

number (IN)

Number to convert.

rsl_length (IN)

Size of the desired result.

rsl_flag (IN)

Flag that designates the sign of the output, as follows:

• OCI_NUMBER_UNSIGNED - Unsigned values
• OCI_NUMBER_SIGNED - Signed values

rsl (OUT)

Pointer to space for the result.

Comments

This is a native type conversion function. It converts the given Oracle number into an integer of the form xbn, such as ub2, ub4, or sb2.

This function returns an error if number or rsl is null, if number is too big (overflow) or too small (underflow), or if an invalid sign flag value is passed in rsl_flag.

Related Functions

OCIErrorGet(), OCINumberFromInt()