OCIHandleFree()

Purpose

This call explicitly deallocates a handle.

Syntax

sword OCIHandleFree ( dvoid     *hndlp,
                      ub4       type );

Parameters

hndlp (IN)

A handle allocated by OCIHandleAlloc().

type (IN)

Specifies the type of storage to be freed. The specific types are:

• OCI_HTYPE_CPOOL - a connection pool handle
• OCI_HTYPE_ENV - an environment handle
• OCI_HTYPE_ERROR - an error report handle
• OCI_HTYPE_SVCCTX - a service context handle
• OCI_HTYPE_STMT - a statement (application request) handle
• OCI_HTYPE_DESCRIBE - a select list description handle
• OCI_HTYPE_SERVER - a server handle
• OCI_HTYPE_SESSION - a user session handle
• OCI_HTYPE_TRANS - a transaction handle
• OCI_HTYPE_COMPLEXOBJECT - a complex object retrieval handle
• OCI_HTYPE_SECURITY - a security handle
• OCI_HTYPE_SUBSCR - a subscription handle
• OCI_HTYPE_DIRPATH_CTX - direct path context handle
• OCI_HTYPE_DIRPATH_COLUMN_ARRAY - direct path column array handle
• OCI_HTYPE_DIRPATH_STREAM - direct path stream handle
• OCI_HTYPE_PROCESS - process handle

Comments

This call frees up storage associated with a handle, corresponding to the type specified in the type parameter.

This call returns either OCI_SUCCESS or OCI_INVALID_HANDLE.

All handles may be explicitly deallocated. The OCI will deallocate a child handle if the parent is deallocated.

Related Functions

OCIHandleAlloc(), OCIEnvInit()