ora-lob-char-set-form Function

Summary

Returns the character set form of a LOB.

Package

sql

Signature

ora-lob-char-set-form lob-locator &key errorp => charset

Arguments

lob-locator⇩	A LOB locator.
errorp⇩	A generalized boolean.

Values

charset⇩

A non-negative integer.

Description

The function ora-lob-char-set-form returns the char set form of the LOB underlying lob-locator.

charset is 0 for a binary LOB (BLOB or BFILE), SQLCS_IMPLICIT (1) for a character LOB (CFILE or CLOB) and SQLCS_NCHAR (2) for a NCLOB.

If an error occurs and errorp is true, an error is signaled. If errorp is false, the function returns an object of type sql-database-error. The default value of errorp is nil.

Notes

1. This is a direct call to OCILobCharSetForm.
2. ora-lob-char-set-form is available only when the "oracle" module is loaded. See the section 23.11 Oracle LOB interface for more information.