#include <DbXml.hpp>

virtual bool XmlEventReader::needsEntityEscape(int index = 0) const

Description: XmlEventReader::needsEntityEscape

If the current event is Characters, and XmlEventReader::hasEntityEscapeInfo is true, returns whether the current text string requires escaping of entities for XML serialization.

If the current event is StartElement, and XmlEventReader::hasEntityEscapeInfo is true, returns whether the attribute value specified by the index parameter requires escaping of entities for XML serialization.

Parameters

index

If the current event is StartElement, index is the attribute index used to specify an attribute. If the current event is Characters, it is ignored.

Errors

The XmlEventReader::needsEntityEscape method may fail and throw XmlException, encapsulating one of the following non-zero errors:

EVENT_ERROR

An error occurred during processing of an XmlEventReader object. Most likely the error is requesting state that is not valid in the context of the current event.