OCIContextClearValue()

Purpose

This call is used to remove the value that is stored in the context associated with the given key (by calling OCIContextSetValue()).

Syntax

sword OCIContextClearValue( dvoid    *hndl, 
                            OCIError *err, 
                            ub1      *key, 
                            ub1      keylen );

Parameters

hndl (IN)

The OCI environment or user session handle.

err (IN)

The error handle.

key (IN)

Unique key value.

keylen (IN)

Length of the key. Maximum is 64 bits.

Comments

An error is returned when a non-existent key is passed.

Returns

• If operation succeeds, returns OCI_SUCCESS.
• If operation fails, returns OCI_ERROR.