Returns TRUE if an XML column is in uncompressed mode.

Usage syntax

BOOL SE_ xmlcolumninfo_is_in_uncompressed_mode

(const SE_XMLCOLUMNINFO xmlcolumn);

Parameters

Description

This function returns TRUE if an XML column is in uncompressed mode. By default, a column is in compressed mode. That means that the XML document is compressed and then stored in the database as a binary value. When in uncompressed mode, the XML document is not compressed before being stored in the database. This is a convenient option if the application needs to directly query the XML document instead of using the SDE API.

When a column is created in uncompressed mode, the database storage of the document is controlled by the XML_DOC_UNCOMPRESSED_TYPE dbtune parameter of the column’s configuration keyword.

Possible storage options for the document are:

-Binary: (default) This type must be used if storing documents that are a mix of code pages, or that do not match your locale, or your database locale.  By storing the doc in a binary column, there are no code page conversion issues, and all docs will be stored safely.

-Text:  This type can be used if the locale and the encoding for all XML docs that will be stored match exactly, and this code page is an ANSI (not unicode) code page. Also, the code page must be supported by the underlying database text type. Any deviation from this will result in an error.

-Unicode:  The restrictions on the use of this column are the same as for the TEXT type, the differences being this type is for unicode code pages, not ANSI, and underlying database supported text types don't matter. The client locale and xml document must still match perfectly to use this type of storage.

The decision to have XML documents be compressed or uncompressed must be made at the time the column is created. An existing column cannot have its compression mode changed.

Returns

TRUE if the column is in uncompressed mode. All other conditions, including an invalid SE_XMLCOLUMNINFO object, return FALSE.