OCIRefClear()

Purpose

Clears or nullifies a given REF.

Syntax

void OCIRefClear ( OCIEnv        *env,
                   OCIRef        *ref );

Parameters

env (IN/OUT)

The OCI environment handle initialized in object mode.

See Also: OCIEnvCreate() and OCIInitialize()

ref (IN/OUT)

REF to clear.

Comments

A REF is considered to be a null REF if it no longer points to an object. Logically, a null REF is a dangling REF.

Note that a null REF is still a valid SQL value and is not SQL NULL. It can be used as a valid non-null constant REF value for a NOT NULL column or attribute of a row in a table.

If a null pointer value is passed as a REF, then this function is non-operational.

Related Functions

OCIErrorGet(), OCIRefIsNull()