OCIDescriptorFree()

Purpose

Deallocates a previously allocated descriptor.

Syntax

sword OCIDescriptorFree ( dvoid    *descp,
                          ub4      type );

Parameters

descp (IN)

An allocated descriptor.

type (IN)

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

• OCI_DTYPE_SNAP - snapshot descriptor
• OCI_DTYPE_LOB - a LOB value type descriptor
• OCI_DTYPE_FILE - a FILE value type descriptor
• OCI_DTYPE_ROWID - a ROWID descriptor
• OCI_DTYPE_DATE - an ANSI DATE descriptor
• OCI_DTYPE_PARAM - a parameter descriptor
• OCI_DTYPE_TIMESTAMP - a TIMESTAMP descriptor
• OCI_DTYPE_TIMESTAMP_TZ - a TIMESTAMP WITH TIME ZONE descriptor
• OCI_DTYPE_TIMESTAMP_LTZ - a TIMESTAMP WITH LOCAL TIME ZONE descriptor
• OCI_DTYPE_INTERVAL_YM - an INTERVAL YEAR TO MONTH descriptor
• CI_DTYPE_INTERVAL_DS - an INTERVAL DAY TO SECOND descriptor
• OCI_DTYPE_COMPLEXOBJECTCOMP - a complex object retrieval descriptor
• OCI_DTYPE_AQENQ_OPTIONS - an AQ enqueue options descriptor
• OCI_DTYPE_AQDEQ_OPTIONS - an AQ dequeue options descriptor
• OCI_DTYPE_AQMSG_PROPERTIES - an AQ message properties descriptor
• OCI_DTYPE_AQAGENT - an AQ agent descriptor

Comments

This call frees storage associated with a descriptor. Returns OCI_SUCCESS or OCI_INVALID_HANDLE. All descriptors may be explicitly deallocated, however the OCI will deallocate a descriptor if the environment handle is deallocated.

Related Functions

OCIDescriptorAlloc()