OCILobLocatorIsInit()

Purpose

Tests to see if a given LOB/FILE locator is initialized.

Syntax

sword OCILobLocatorIsInit ( OCIEnv               *envhp,
                            OCIError             *errhp,
                            CONST OCILobLocator  *locp,
                            boolean              *is_initialized );

Parameters

envhp (IN/OUT)

OCI environment handle.

errhp (IN/OUT)

An error handle you can pass to OCIErrorGet() for diagnostic information in the event of an error.

locp (IN)

The LOB/FILE locator being tested

is_initialized (OUT)

Returns TRUE if the given LOB/FILE locator is initialized; FALSE if it is not.

Comments

Tests to see if a given LOB/FILE locator is initialized.

Internal LOB locators can be initialized by one of the following methods:

• selecting a non-NULL LOB into the locator,
• pinning an object that contains a non-NULL LOB attribute by OCIObjectPin()
• setting the locator to empty by OCIAttrSet()

  See Also: "LOB Locator Attributes"

FILE locators can be initialized by one of the following methods:

• selecting a non-NULL FILE into the locator
• pinning an object that contains a non-NULL FILE attribute by OCIObjectPin()
• calling OCILobFileSetName()

Related Functions

OCIErrorGet(), OCILobIsEqual()