OCILobCharSetId()

Purpose

Gets the LOB locator's database character set ID, if any.

Syntax

sword OCILobCharSetId ( OCIEnv                  *envhp, 
                        OCIError                *errhp, 
                        CONST OCILobLocator     *locp, 
                        ub2                     *csid );

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)

LOB locator for which to get the character set ID.

csid (OUT)

Database character set ID of the input LOB locator. If the input locator is for a BLOB or a BFILE,csid is set to 0 since there is no concept of a character set for binary LOBs/FILEs. The caller must allocate space for the csid ub2.

Comments

Returns the character set ID of the input LOB locator in the csid output parameter.

This function makes sense only for character LOBs (that is, CLOBs, NCLOBs).

Related Functions

OCIErrorGet(), OCILobCharSetForm(), OCILobLocatorIsInit()