Returns the type of XML index information.

Usage syntax

LONG SE_xmlindexinfo_get_type
(SE_XMLINDEXINFO xml_index,
LONG *info_type);

Parameters

Description

An SE_XMLINDEXINFO object can contain one of several different types of XML index information. SE_xmlindexinfo_get_type returns a value that indicates the type of information in a given SE_XMLINDEXINFO object. The value for info_type will be one of these values:

• SE_XML_INDEX_TEMPLATE - Index template
• SE_XML_INDEX_DEFINITION - Index definition
• SE_XML_INDEX_AUTO - Index definition with automatic indexing (default)
• SE_XML_INDEX_AUTO_STRING - Same as an auto index except that every tag will be coerced into a string type. Provides easy method to load data unknown tag data types and avoid all tag conflicts.

Returns

SE_SUCCESS
SE_INVALID_POINTER
SE_INVALID_XMLINDEX_OBJECT
SE_SDE_NOT_STARTED

Notes

When initialized with SE_xmlindexinfo_create, the index information of the SE_XMLINDEXINFO object is set to SE_XML_INDEX_AUTO. The type can be set to another value by calling SE_xmlindexinfo_set_type.

Please also see additional information about types of XML index information.