OCIDateTimeIntervalSub()

Purpose

Subtracts an interval from a datetime and stores the result in a datetime.

Syntax

sword OCIDateTimeIntervalSub ( dvoid        *hndl,
                               OCIError     *err, 
                               OCIDateTime  *datetime, 
                               OCIInterval  *inter,
                               OCIDateTime  *outdatetime );

Parameters

hndl (IN)

The user session or environment handle. If a session handle is passed, the subtraction takes place in the session default calendar. The interval is assumed to be in the session calendar.

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

datetime (IN)

Pointer to the input datetime value.

inter (IN)

Pointer to the input interval.

outdatetime (OUT)

Pointer to the output datetime. The output datetime will be of same type as the input datetime.

Returns

OCI_SUCCESS if the function completes successfully,

OCI_INVALID_HANDLE, if err is a null pointer,

OCI_ERROR, if the resulting date is before Jan 1, -4713, or is after Dec 31, 9999.

Related Functions

OCIDateTimeIntervalAdd()