OCINumberFromText()

Purpose

Converts character string to Oracle number.

Syntax

sword OCINumberFromText ( OCIError           *err, 
                          CONST OraText      *str, 
                          ub4                str_length,
                          CONST OraText      *fmt,
                          ub4                fmt_length, 
                          CONST OraText      *nls_params, 
                          ub4                nls_p_length, 
                          OCINumber          *number );

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().

str (IN)

Input string to convert to Oracle number.

str_length (IN)

Size of the input string.

fmt (IN)

Conversion format.

fmt_length (IN)

Length of the fmt parameter.

nls_params (IN)

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

nls_p_length (IN)

Length of the nls_params parameter.

number (OUT)

Given string converted to number.

Comments

Converts the given string to a number according to the specified format. Refer to the TO_NUMBER conversion function described in the Oracle9i SQL Referenceffor a description of format and multilingual parameters.

This function returns an error if there is an invalid format, an invalid multibyte format, or an invalid input string, if number or str is null, or if str_length is zero.

Related Functions

OCIErrorGet(), OCINumberToText()