SE_xmlindexinfo_set

SE_xmlindexinfo_set_description

Sets the XML index's description.

Usage syntax

LONG SE_xmlindexinfo_set_description
(SE_XMLINDEXINFO xml_index,
const CHAR *description);

Parameters

xml_index	The XML index information object.
description	A pointer to a text string containing the description.

Description

SE_xmlindexinfo_set_description sets the XML index's description. If this function has not been called on a new, intialized SE_XMLINDEXINFO object, the description of the SE_XMLINDEXINFO structure defaults to an empty string. The string can be up to SE_MAX_DESCRIPTION_LEN characters in length, including the terminating NULL.

Returns

SE_SUCCESS
SE_INVALID_PARAM_VALUE
SE_INVALID_POINTER
SE_INVALID_XMLINDEX_OBJECT
SE_SDE_NOT_STARTED