OCIIntervalFromText()

Purpose

Given an interval string, returns the interval represented by the string. The type of the interval is the type of the result descriptor.

Syntax

sword OCIIntervalFromText ( dvoid          *hndl, 
                            OCIError       *err, 
                            CONST OraText  *inpstring,
                            size_t         str_len,
                            OCIInterval    *result );

Parameters

hndl (IN)

The OCI user session handle or the environment handle.

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

inpstring (IN)

Input string.

str_len (IN)

Length of the input string.

result (OUT)

Resultant interval.

Returns

OCI_SUCCESS,

OCI_INVALID_HANDLE, if err is a null pointer,

OCI_ERROR, if any of the following are true:

• there are too many fields in the literal string

• the year is out of range (-4713 to 9999)

• the month is out of range (1 to 12)

• the day of month is out of range (1 to 28...31)

• the hour is out of range (0 to 23)

• if hour is out of range (0 to 11)

• if minute is out of range (0 to 59)

• if seconds in minute out of range (0 to 59)

• if seconds in day out of range (0 to 86399)

• if the interval is invalid

Related Functions

OCIIntervalToText()