XmlIndexSpecification::next

XmlIndexSpecification::next
Prev	Chapter 16. XmlIndexSpecification	Next

#include <DbXml.hpp>

bool XmlIndexSpecification::next(std::string &uri, std::string &name,
    std::string &index)

bool XmlIndexSpecification::next(std::string &uri, std::string &name,
    Type &type, XmlValue::Type &syntax)

Obtains the next index in the XmlIndexSpecification . Use XmlIndexSpecification::reset to reset this iterator.

This method returns true if additional indices exist in the index list, otherwise it returns false.

Indexes can be retrieved as a string, or as an enumerated value.

Retrieving indexes as strings

#include <DbXml.hpp>

bool XmlIndexSpecification::next(std::string &uri, std::string &name,
    std::string &index)

Returns the next index in the index specification in a string format.

Parameters are:

uri

Receives the namespace of the node to which this index is applied.

name

Receives the name of the node to which this index is applied.

index

Identifies the index type used by this index. See the XmlIndexSpecification::addIndex method for a description of what this string means.

Retrieving indexes as enumerated values

#include <DbXml.hpp>

bool XmlIndexSpecification::next(std::string &uri, std::string &name,
    Type &type, XmlValue::Type &syntax)

Returns the next index in the index specification using XmlIndexSpecification::Type and XmlValue::Type format.

Parameters are:

uri

Receives the namespace of the node to which this index is applied.

name

Receives the name of the node to which this index is applied.

type

Identifies the XmlIndexSpecification::Type used by this index. The value presented here is 3 or 4 different XmlIndexSpecification::Type values or'd together. See XmlIndexSpecification::addIndex for a listing of these enumeration values.

syntax

Identifies the syntax used by this index. The value presented here is and XmlValue::Type value. See XmlIndexSpecification::addIndex for a listing of these enumeration values.

Class

XmlIndexSpecification

Prev	Up	Next
XmlIndexSpecification::getValueType	Home	XmlIndexSpecification::replaceDefaultIndex