OCILobCharSetForm()

Purpose

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

Syntax

sword OCILobCharSetForm ( OCIEnv                *envhp, 
                          OCIError              *errhp, 
                          CONST OCILobLocator   *locp, 
                          ub1                   *csfrm );

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 form.

csfrm (OUT)

Character set form of the input LOB locator. If the input locator, locp, is for a BLOB or a BFILE,csfrm is set to 0 since there is no concept of a character set for binary LOBs and FILEs. The caller must allocate space for the csfrm (a ub1).

csfrm has two possible nonzero values:

• SQLCS_IMPLICIT - database character set ID
• SQLCS_NCHAR - NCHAR character set ID

The default value is SQLCS_IMPLICIT.

Comments

Returns the character set form of the input LOB locator in the csfrm output parameter. This function makes sense only for character LOBs (that is, CLOBs and NCLOBs).

Related Functions

OCIErrorGet(), OCILobCharSetId(), OCILobLocatorIsInit()