IFastXmlCallback Class Reference

#include <FastXml.h>

Public Member Functions
virtual bool	ProcessXmlDeclaration (const TCHAR *ElementData, int32 XmlFileLineNumber)=0
virtual bool	ProcessElement (const TCHAR *ElementName, const TCHAR *ElementData, int32 XmlFileLineNumber)=0
virtual bool	ProcessAttribute (const TCHAR *AttributeName, const TCHAR *AttributeValue)=0
virtual bool	ProcessClose (const TCHAR *Element)=0
virtual bool	ProcessComment (const TCHAR *Comment)=0

Detailed Description

Create your own class that implements the IFastXmlCallback interface to process the XML elements as they are loaded by FFastXml::ParseXmlFile(). You'll receive a ProcessElement() call for every XML element that is encountered, along with a corresponding ProcessClose() when that element's scope has ended. ProcessAttribute() will be called for any attributes found within the scope of the current element.

Member Function Documentation

ProcessAttribute()

virtual bool IFastXmlCallback::ProcessAttribute ( const TCHAR *  AttributeName, const TCHAR *  AttributeValue  )

pure virtual

Called when an XML attribute is encountered for the current scope's element.

Parameters

AttributeName	The name of the attribute
AttributeValue	The value of the attribute

Returns

You should return true to continue processing the file, or false to stop processing immediately.

ProcessClose()

virtual bool IFastXmlCallback::ProcessClose ( const TCHAR *  Element )

pure virtual

Called when an element's scope ends in the XML file

Parameters

ElementName

Name of the element whose scope closed

Returns

You should return true to continue processing the file, or false to stop processing immediately.

ProcessComment()

virtual bool IFastXmlCallback::ProcessComment ( const TCHAR *  Comment )

pure virtual

Called when a comment is encountered. This can happen pretty much anywhere in the file.

Parameters

Comment

The comment text

ProcessElement()

virtual bool IFastXmlCallback::ProcessElement ( const TCHAR *  ElementName, const TCHAR *  ElementData, int32  XmlFileLineNumber  )

pure virtual

Called when a new XML element is encountered, starting a new scope. You'll receive a call to ProcessClose() when this element's scope has ended.

Parameters

ElementName	The name of the element
ElementData	Optional data for this element, nullptr if none
XmlFileLineNumber	The line number in the XML file we're on

Returns

You should return true to continue processing the file, or false to stop processing immediately.

ProcessXmlDeclaration()

virtual bool IFastXmlCallback::ProcessXmlDeclaration ( const TCHAR *  ElementData, int32  XmlFileLineNumber  )

pure virtual

Called after the XML's header is parsed. This is usually the first call that you'll get back.

Parameters

ElementData	Optional data for this element, nullptr if none
XmlFileLineNumber	Line number in the XML file we're on

Returns

You should return true to continue processing the file, or false to stop processing immediately.

---

The documentation for this class was generated from the following file:

• Engine/Source/Runtime/XmlParser/Public/FastXml.h