Returns an XML column's index information from an SE_XMLCOLUMNINFO object.

Usage syntax

LONG SE_xmlcolumninfo_get_index
(const SE_XMLCOLUMNINFO columninfo,
SE_XMLINDEXINFO indexinfo);

Parameters

Description

This function retrieves an XML column's index information contained in the specified SE_XMLCOLUMNINFO object, placing the index inforamtion into an SE_XMLINDEXINFO object. The SE_XMLINDEXINFO object must first be initialized with a call to SE_xmlindexinfo_create before calling this function.

If the SE_XMLCOLUMNINFO object contains no index information, this function leaves the SE_XMLINDEXINFO object unchanged. Alternatively, use SE_xmlcolumninfo_has_index to check if index information is contained in the SE_XMLCOLUMNINFO object.

Returns

SE_SUCCESS
SE_INVALID_POINTER
SE_INVALID_XMLCOLUMN_OBJECT
SE_INVALID_XMLINDEX_OBJECT
SE_OUT_OF_CLMEM
SE_SDE_NOT_STARTED