#include <DbXml.hpp>

virtual void XmlEventWriter::writeStartEntity(const unsigned char *name
	     				      bool expandedInfoFollows)

Description: XmlEventWriter::writeStartEntity

Write StartEntityReference event to the XmlEventWriter. This event must be followed, later in the document, by a call to XmlEventWriter::writeEndEntity. Writing of StartEntityReference and EndEntityReference events is optional, but helpful for round-tripping of documents. A given implementation of XmlEventWriter may safely ignore such events.

Parameters

name

The name of the entity reference.

expandedInfoFollows

If the entity reference is expanded, and the expanded events will be written, this parameter should be specified as true. If the entity is not to be expanded, false should be used.

Errors

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

EVENT_ERROR

An error occurred during processing of an XmlEventWriter object. Most likely the error is attempting to write a type or value that is not valid in the current state of the object.