OCIObjectPinTable()

Purpose

Pins a table object for a specified duration.

Syntax

sword OCIObjectPinTable ( OCIEnv             *env, 
                          OCIError           *err, 
                          CONST OCISvcCtx    *svc, 
                          CONST OraText      *schema_name,
                          ub4                s_n_length, 
                          CONST OraText      *object_name, 
                          ub4                o_n_length, 
                          dvoid              *not_used, 
                          OCIDuration        pin_duration, 
                          dvoid              **object );

Parameters

env (IN/OUT)

The OCI environment handle initialized in object mode. See the description of OCIEnvCreate() and OCIInitialize() for more information.

err (IN/OUT)

The OCI error handle. If there is an error, it is recorded in err and this function returns OCI_ERROR. Obtain diagnostic information by calling OCIErrorGet().

svc (IN)

The OCI service context handle.

schema_name (IN) [optional]

The schema name of the table.

s_n_length (IN) [optional]

The length of the schema name indicated in schema_name, in bytes.

object_name (IN)

The name of the table.

o_n_length (IN)

The length of the table name specified in object_name, in bytes.

not_used (IN/OUT)

This parameter is not currently used. Pass as null.

pin_duration (IN)

The pin duration.

object (OUT)

The pinned table object.

Comments

This function pins a table object with the specified pin duration. The client can unpin the object by calling OCIObjectUnpin().

The table object pinned by this call can be passed as a parameter to OCIObjectNew() to create a standalone persistent object.

Related Functions

OCIObjectPin(), OCIObjectUnpin()