Returns the XML index's description.

Usage syntax

LONG SE_xmlindexinfo_get_description
(SE_XMLINDEXINFO xml_index,
CHAR *description);

Parameters

Description

This function returns the description contained in the XML index information object. If a description has not been set in the object, the function returns the default empty string. The caller must allocate a CHAR buffer at least SE_MAX_DESCRIPTION_LEN in length to receive the index description string.

Returns

SE_SUCCESS
SE_INVALID_POINTER
SE_INVALID_XMLINDEX_OBJECT
SE_SDE_NOT_STARTED