OCIRefIsNull()

Purpose

Tests if a REF is null.

Syntax

boolean OCIRefIsNull ( OCIEnv           *env,
                       CONST OCIRef     *ref );

Parameters

env (IN/OUT)

The OCI environment handle initialized in object mode.

See Also: OCIEnvCreate() and OCIInitialize()

ref (IN)

REF to test for null.

Returns

Returns TRUE if the given REF is null; otherwise, returns FALSE.

Comments

A REF is null if and only if:

• it is supposed to be referencing a persistent object, but the object's identifier is null
• it is supposed to be referencing a transient object, but it is currently not pointing to an object.

  Note: A REF is a dangling REF if the object that it points to does not exist.

Related Functions

OCIErrorGet(), OCIRefClear()