OCINumberToText()

Purpose

Converts an Oracle number to a character string according to a specified format.

Syntax

sword OCINumberToText ( OCIError             *err,
                        CONST OCINumber      *number, 
                        CONST OraText        *fmt, 
                        ub4                  fmt_length,
                        CONST OraText        *nls_params, 
                        ub4                  nls_p_length,
                        ub4                  *buf_size, 
                        text                 *buf );

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)

Oracle number to convert.

fmt (IN)

Conversion format.

fmt_length (IN)

Length of the fmt parameter.

nls_params (IN)

Global Support format specification. If it is a null string ((text *)0 ), then the default parameters for the session is used.

nls_p_length (IN)

Length of the nls_params parameter.

buf_size (IN)

Size of the buffer.

buf (OUT)

Buffer into which the converted string is placed.

Comments

Refer to the TO_NUMBER conversion function described in the Oracle9i SQL Reference for a description of format and Global Support parameters.

The converted number string is stored in buf, up to a maximum of buf_size bytes. This function returns an error if:

• number or buf is null
• buffer is too small
• invalid format or invalid multibyte format is passed
• number to text translation for given format causes an overflow

Related Functions

OCIErrorGet(), OCINumberFromText()