XML Class

Properties Methods Events Config Settings Errors

The XML class can be used to both parse and create XML documents.

Syntax

XML

Remarks

The XML class can operate as either a parser or writer of XML.

Parsing XML

The XML class parses XML documents and verifies that they are well formed. The results are provided through a set of events complying with the SAX2 specification.

In addition, the document structure may be queried through an XPath mechanism that supports a subset of the XPath specification.

The parser is optimized for read applications, with a very fast engine that builds internal Document Object Model (DOM) structures with close to zero heap allocations. Additionally, BuildDOM can be set to False, which reduces the overhead of creating the DOM and offers a fast forward-only parsing implementation that fires events to provide the parsed data.

When parsing a document, events will fire to provide information about the parsed data. After Parse returns, the document may be navigated by setting XPath if BuildDOM is True (default). If BuildDOM is False, parsed data are accessible only through the events.

Events are fired only when qualifying conditions (e.g., the beginning of a new element) are met. In the meantime, text will be buffered internally. The following events will fire during parsing:

Characters
Comment
EndElement
EndPrefixMapping
EvalEntity
IgnorableWhitespace
Meta
PI
SpecialSection
StartElement
StartPrefixMapping

If BuildDOM is True (default), XPath may be set after this method returns. XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:


'name'	A particular element name
name[i]	The i-th subelement of the current element with the given name
[i]	The i-th subelement of the current element
[last()]	The last subelement of the current element
[last()-i]	The subelement located at the last location minus i in the current element
name[@attrname="attrvalue"]	The subelement containing a particular value for a given attribute (supports single AND double quotes)
..	The parent of the current element

When XPath is set to a valid path, XElement points to the name of the element, with XParent, XNamespace, XPrefix, Name, Namespace, Prefix, XText, and XText providing other properties of the element. The attributes of the current element are provided in the Name, Namespace, Prefix, and Value properties.

BuildDOM must be set to True before parsing the document for the XPath functionality to be available.

Example. Setting XPath:


Document root	XML.XPath = "/"
Specific Element	XML.XPath = "/root/SubElement1/SubElement2/"
i-th Child	XML.XPath = "/root/SubElement1[i]"

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

InputFile
InputData

When a valid source is found, the search stops.

If parsing multiple documents, call Reset between documents to reset the parser.

An additional "relaxed" mode allows for lexical parsing of non-XML documents (e.g., HTML). This is enabled by setting Validate to False. In this case, events will be fired as elements, entities, and so on are encountered, but the structure of the document will not be checked for "well-formedness", and the internal DOM structure will not be built.

Writing XML

To use the class, first decide whether or not to write to file, or to OutputData.

Output Properties

The class will determine the destination of the output based on which properties are set.

The order in which the output properties are checked is as follows:

OutputFile
OutputData: The output data are written to this property if no other destination is specified.

To begin writing the XML document, first optionally set XMLDeclaration. If this is not set, the class will use a default XML declaration at the beginning of the document.

Next, begin adding elements to your document. Calling StartElement will open an element with the specified name. To create a nested structure, continue calling StartElement to open more child elements. To write a value within an element, call PutString. To close the element that was last opened, call EndElement. Each time EndElement is called, the element at the current level is closed. Alternatively, calling PutElement will write the element specified with the value specified and will also close the element.

To write an attribute of the current element, after calling StartElement call PutAttr. Call PutAttr multiple times to add multiple attributes.

Writing comments or CDATA can be done at any time with the PutComment and PutCData methods.

To close your XML document, call Save. You can call Save from any location, and it will close any remaining open elements automatically.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


BuildDOM	When set to True, this property creates an internal object model of the XML document.
InputData	This property specifies the XML data to parse.
InputFile	This property specifies the file to process.
Namespaces	This property includes a collection of namespaces in the current namespace stack.
OutputData	The output XML after processing.
OutputFile	This property includes the path to a local file where the output will be written.
Overwrite	This property indicates whether or not the class should overwrite files.
Validate	This property controls whether documents are validated during parsing.
XAttributes	This property includes a collection of attributes of the current element.
XChildren	This property includes a collection of child elements of the currently selected XML element.
XComments	This property includes a collection of comments of the current element.
XElement	This property includes the name of the current element.
XMLDeclaration	This property specifies details of the XML declaration.
XNamespace	This property includes the namespace of the current element.
XParent	This property includes the parent of the current element.
XPath	This property provides a way to point to a specific element in the document.
XPrefix	This property includes the prefix of the current element.
XSubTree	This property includes a snapshot of the current element in the document.
XText	This property includes the text of the current element.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


Config	Sets or retrieves a configuration setting.
EndElement	This method writes the closing tag of an open XML element.
Flush	This method flushes the parser and checks its end state.
GetAttr	This method returns the value of the specified attribute.
HasXPath	This method determines whether a specific element exists in the document.
LoadDOM	This method loads the document object model (DOM) from a file.
LoadSchema	This method loads the XML schema.
Parse	This method parses the specified XML data.
PutAttr	This method writes an XML attribute.
PutCData	This method writes an XML CDATA block.
PutComment	This method writes an XML comment block.
PutElement	This method writes a simple XML element with a value.
PutRaw	This method writes a raw XML fragment.
PutString	This method writes text inside an XML element.
RemoveAttr	This method removes an attribute.
RemoveChildren	This method removes the children of the element as the specified XPath.
RemoveElement	This method removes the element as the specified XPath.
Reset	This method resets the parser.
Save	This method closes the class writing stream.
SaveDOM	This method saves the DOM to a file.
SetInputStream	This method sets the stream from which the class will read data to parse.
SetOutputStream	This method sets the stream to which the class will write the XML.
StartElement	This method writes the opening tag of an XML element.
TryXPath	This method navigates to the specified XPath if it exists.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


Characters	This event is fired for plaintext segments of the input stream.
Comment	This event is fired when a comment section is encountered.
EndElement	This event is fired when an end-element tag is encountered.
EndPrefixMapping	This event is fired when leaving the scope of a namespace declaration.
Error	Fired when information is available about errors during data delivery.
EvalEntity	This event is fired every time an entity needs to be evaluated.
IgnorableWhitespace	This event is fired when a section of ignorable whitespace is encountered.
Meta	This event fires when a meta section is encountered.
PI	This event is fired when a processing instruction section is encountered.
SpecialSection	This event is fired when a special section is encountered.
StartElement	This event is fired when a begin-element tag is encountered in the document.
StartPrefixMapping	This event is fired when entering the scope of a namespace declaration.
XML	This event is fired as XML is written.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.


CacheContent	If true, the original XML is saved in a buffer.
Charset	Specifies the charset used when encoding data.
EOL	The characters to use for separating lines.
ErrorOnEmptyAttr	If true, passing an invalid attribute to the Attr method will throw an exception.
ExtraNameChars	Extra characters for the parser to consider as name characters.
ExtraSpaceChars	Extra characters for the parser to consider as white space.
FlushOnEOL	If set, the parser flushes its text buffer after every line of text.
IgnoreBadAttributePrefixes	If true, bad (unknown) attribute prefixes are ignored.
IgnoreBadElementPrefixes	If true, bad (unknown) element prefixes are ignored.
IncludeElementPrefix	Whether to include the prefix in the element name.
IncludeXMLDeclaration	Whether to include the XML declaration when writing XML.
Indent	The characters to use for each indentation level.
Offset	Current offset of the document being parsed.
PreserveWhitespace	If true, leading and trailing whitespace in element text is preserved.
QuoteChar	Quote character to use for attribute values.
StringProcessingOptions	Defines options to use when processing string values.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

BuildDOM Property (XML Class)

When set to True, this property creates an internal object model of the XML document.

Syntax

ANSI (Cross Platform)
int GetBuildDOM();
int SetBuildDOM(int bBuildDOM);

Unicode (Windows)
BOOL GetBuildDOM();
INT SetBuildDOM(BOOL bBuildDOM);

int ipworks_xml_getbuilddom(void* lpObj);
int ipworks_xml_setbuilddom(void* lpObj, int bBuildDOM);

bool GetBuildDOM();
int SetBuildDOM(bool bBuildDOM);

Default Value

TRUE

Remarks

Set BuildDOM to True when you need to browse the current document through XPath.

Validate is automatically set to True when BuildDOM is set to True.

Data Type

Boolean

InputData Property (XML Class)

This property specifies the XML data to parse.

Syntax

ANSI (Cross Platform)
char* GetInputData();
int SetInputData(const char* lpszInputData);

Unicode (Windows)
LPWSTR GetInputData();
INT SetInputData(LPCWSTR lpszInputData);

char* ipworks_xml_getinputdata(void* lpObj);
int ipworks_xml_setinputdata(void* lpObj, const char* lpszInputData);

QString GetInputData();
int SetInputData(QString qsInputData);

Default Value

Remarks

This property specifies the XML to be processed. Set this property before calling Parse.

This property may be set to a complete XML document or to partial data. When setting partial data, call Parse after each chunk of data is set. For instance:

//Parse the following in chunks: <test>1</test> xml.InputData = "<test>" xml.Parse(); xml.InputData = "1<test>" xml.Parse();

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

InputFile
InputData

When a valid source is found, the search stops.

Data Type

String

InputFile Property (XML Class)

This property specifies the file to process.

Syntax

ANSI (Cross Platform)
char* GetInputFile();
int SetInputFile(const char* lpszInputFile);

Unicode (Windows)
LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);

char* ipworks_xml_getinputfile(void* lpObj);
int ipworks_xml_setinputfile(void* lpObj, const char* lpszInputFile);

QString GetInputFile();
int SetInputFile(QString qsInputFile);

Default Value

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file that will be processed.

After setting this property, call Parse to parse the document.

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

InputFile
InputData

When a valid source is found, the search stops.

Data Type

String

Namespaces Property (XML Class)

This property includes a collection of namespaces in the current namespace stack.

Syntax

IPWorksList<IPWorksXMLNamespace>* GetNamespaces();
int SetNamespaces(IPWorksList<IPWorksXMLNamespace>* val);

int ipworks_xml_getnamespacecount(void* lpObj);
int ipworks_xml_setnamespacecount(void* lpObj, int iNamespaceCount);

char* ipworks_xml_getnamespaceprefix(void* lpObj, int namespaceindex);
int ipworks_xml_setnamespaceprefix(void* lpObj, int namespaceindex, const char* lpszNamespacePrefix);

char* ipworks_xml_getnamespaceuri(void* lpObj, int namespaceindex);
int ipworks_xml_setnamespaceuri(void* lpObj, int namespaceindex, const char* lpszNamespaceURI);

int GetNamespaceCount();
int SetNamespaceCount(int iNamespaceCount);

QString GetNamespacePrefix(int iNamespaceIndex);
int SetNamespacePrefix(int iNamespaceIndex, QString qsNamespacePrefix);

QString GetNamespaceURI(int iNamespaceIndex);
int SetNamespaceURI(int iNamespaceIndex, QString qsNamespaceURI);

Remarks

This property contains a collection of XML namespaces, which are standards for providing uniquely named elements and attributes in an XML instance.

This property is not available at design time.

Data Type

IPWorksXMLNamespace

OutputData Property (XML Class)

The output XML after processing.

Syntax

ANSI (Cross Platform)
char* GetOutputData();
int SetOutputData(const char* lpszOutputData);

Unicode (Windows)
LPWSTR GetOutputData();
INT SetOutputData(LPCWSTR lpszOutputData);

char* ipworks_xml_getoutputdata(void* lpObj);
int ipworks_xml_setoutputdata(void* lpObj, const char* lpszOutputData);

QString GetOutputData();
int SetOutputData(QString qsOutputData);

Default Value

Remarks

This property will be populated with the output from the operation if OutputFile is not set.

Data Type

String

OutputFile Property (XML Class)

This property includes the path to a local file where the output will be written.

Syntax

ANSI (Cross Platform)
char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile);

Unicode (Windows)
LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);

char* ipworks_xml_getoutputfile(void* lpObj);
int ipworks_xml_setoutputfile(void* lpObj, const char* lpszOutputFile);

QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);

Default Value

Remarks

This property specifies the file to which the output will be written. This may be set to an absolute or relative path.

Output Properties

The class will determine the destination of the output based on which properties are set.

The order in which the output properties are checked is as follows:

OutputFile
OutputData: The output data are written to this property if no other destination is specified.

Data Type

String

Overwrite Property (XML Class)

This property indicates whether or not the class should overwrite files.

Syntax

ANSI (Cross Platform)
int GetOverwrite();
int SetOverwrite(int bOverwrite);

Unicode (Windows)
BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);

int ipworks_xml_getoverwrite(void* lpObj);
int ipworks_xml_setoverwrite(void* lpObj, int bOverwrite);

bool GetOverwrite();
int SetOverwrite(bool bOverwrite);

Default Value

FALSE

Remarks

This property indicates whether or not the class will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.

Data Type

Boolean

Validate Property (XML Class)

This property controls whether documents are validated during parsing.

Syntax

ANSI (Cross Platform)
int GetValidate();
int SetValidate(int bValidate);

Unicode (Windows)
BOOL GetValidate();
INT SetValidate(BOOL bValidate);

int ipworks_xml_getvalidate(void* lpObj);
int ipworks_xml_setvalidate(void* lpObj, int bValidate);

bool GetValidate();
int SetValidate(bool bValidate);

Default Value

TRUE

Remarks

When true (default), the document will be validated during parsing. To disable validation set Validate to false. Disabling validation may be useful in cases in which data can still be parsed even if the document is not well formed.

Data Type

Boolean

XAttributes Property (XML Class)

This property includes a collection of attributes of the current element.

Syntax

IPWorksList<IPWorksXMLAttribute>* GetXAttributes();
int SetXAttributes(IPWorksList<IPWorksXMLAttribute>* val);

int ipworks_xml_getattrcount(void* lpObj);
int ipworks_xml_setattrcount(void* lpObj, int iAttrCount);

char* ipworks_xml_getattrname(void* lpObj, int attrindex);

char* ipworks_xml_getattrnamespace(void* lpObj, int attrindex);

char* ipworks_xml_getattrprefix(void* lpObj, int attrindex);

char* ipworks_xml_getattrvalue(void* lpObj, int attrindex);

int GetAttrCount();
int SetAttrCount(int iAttrCount);

QString GetAttrName(int iAttrIndex);

QString GetAttrNamespace(int iAttrIndex);

QString GetAttrPrefix(int iAttrIndex);

QString GetAttrValue(int iAttrIndex);

Remarks

This collection consists of all attributes of the current XML element. The component parses each attribute into a collection of XMLAttribute types.

This property is not available at design time.

Data Type

IPWorksXMLAttribute

XChildren Property (XML Class)

This property includes a collection of child elements of the currently selected XML element.

Syntax

IPWorksList<IPWorksXMLElement>* GetXChildren();
int SetXChildren(IPWorksList<IPWorksXMLElement>* val);

int ipworks_xml_getxchildcount(void* lpObj);
int ipworks_xml_setxchildcount(void* lpObj, int iXChildCount);

char* ipworks_xml_getxchildname(void* lpObj, int xchildindex);

char* ipworks_xml_getxchildnamespace(void* lpObj, int xchildindex);

char* ipworks_xml_getxchildprefix(void* lpObj, int xchildindex);

char* ipworks_xml_getxchildxtext(void* lpObj, int xchildindex);

int GetXChildCount();
int SetXChildCount(int iXChildCount);

QString GetXChildName(int iXChildIndex);

QString GetXChildNamespace(int iXChildIndex);

QString GetXChildPrefix(int iXChildIndex);

QString GetXChildXText(int iXChildIndex);

Remarks

This property contains a collection of child elements of the currently selected XML element. The elements are provided in the collection in the same order they are found in the XML document.

This property is not available at design time.

Data Type

IPWorksXMLElement

XComments Property (XML Class)

This property includes a collection of comments of the current element.

Syntax

IPWorksList<IPWorksXMLComment>* GetXComments();
int SetXComments(IPWorksList<IPWorksXMLComment>* val);

int ipworks_xml_getxcommentcount(void* lpObj);
int ipworks_xml_setxcommentcount(void* lpObj, int iXCommentCount);

char* ipworks_xml_getxcommenttext(void* lpObj, int xcommentindex);
int ipworks_xml_setxcommenttext(void* lpObj, int xcommentindex, const char* lpszXCommentText);

int GetXCommentCount();
int SetXCommentCount(int iXCommentCount);

QString GetXCommentText(int iXCommentIndex);
int SetXCommentText(int iXCommentIndex, QString qsXCommentText);

Remarks

This collection consists of all comments of the element at the current XPath. The class parses each comment into a collection of XMLComment types.

This functionality is not yet implemented.

This property is not available at design time.

Data Type

IPWorksXMLComment

XElement Property (XML Class)

This property includes the name of the current element.

Syntax

ANSI (Cross Platform)
char* GetXElement();
int SetXElement(const char* lpszXElement);

Unicode (Windows)
LPWSTR GetXElement();
INT SetXElement(LPCWSTR lpszXElement);

char* ipworks_xml_getxelement(void* lpObj);
int ipworks_xml_setxelement(void* lpObj, const char* lpszXElement);

QString GetXElement();
int SetXElement(QString qsXElement);

Default Value

Remarks

The current element is specified through the XPath property.

Data Type

String

XMLDeclaration Property (XML Class)

This property specifies details of the XML declaration.

Syntax

IPWorksXMLDeclaration* GetXMLDeclaration();
int SetXMLDeclaration(IPWorksXMLDeclaration* val);

char* ipworks_xml_getxmldeclarationencoding(void* lpObj);
int ipworks_xml_setxmldeclarationencoding(void* lpObj, const char* lpszXMLDeclarationEncoding);

int ipworks_xml_getxmldeclarationstandalone(void* lpObj);
int ipworks_xml_setxmldeclarationstandalone(void* lpObj, int bXMLDeclarationStandalone);

char* ipworks_xml_getxmldeclarationversion(void* lpObj);
int ipworks_xml_setxmldeclarationversion(void* lpObj, const char* lpszXMLDeclarationVersion);

QString GetXMLDeclarationEncoding();
int SetXMLDeclarationEncoding(QString qsXMLDeclarationEncoding);

bool GetXMLDeclarationStandalone();
int SetXMLDeclarationStandalone(bool bXMLDeclarationStandalone);

QString GetXMLDeclarationVersion();
int SetXMLDeclarationVersion(QString qsXMLDeclarationVersion);

Remarks

This property holds details of the XML declaration for the document being written.

This is applicable only when writing XML.

Data Type

IPWorksXMLDeclaration

XNamespace Property (XML Class)

This property includes the namespace of the current element.

Syntax

ANSI (Cross Platform)
char* GetXNamespace();
int SetXNamespace(const char* lpszXNamespace);

Unicode (Windows)
LPWSTR GetXNamespace();
INT SetXNamespace(LPCWSTR lpszXNamespace);

char* ipworks_xml_getxnamespace(void* lpObj);
int ipworks_xml_setxnamespace(void* lpObj, const char* lpszXNamespace);

QString GetXNamespace();
int SetXNamespace(QString qsXNamespace);

Default Value

Remarks

The current element is specified through the XPath property.

Data Type

String

XParent Property (XML Class)

This property includes the parent of the current element.

Syntax

ANSI (Cross Platform)
char* GetXParent();

Unicode (Windows)
LPWSTR GetXParent();

char* ipworks_xml_getxparent(void* lpObj);

QString GetXParent();

Default Value

Remarks

The current element is specified through the XPath property.

This property is read-only.

Data Type

String

XPath Property (XML Class)

This property provides a way to point to a specific element in the document.

Syntax

ANSI (Cross Platform)
char* GetXPath();
int SetXPath(const char* lpszXPath);

Unicode (Windows)
LPWSTR GetXPath();
INT SetXPath(LPCWSTR lpszXPath);

char* ipworks_xml_getxpath(void* lpObj);
int ipworks_xml_setxpath(void* lpObj, const char* lpszXPath);

QString GetXPath();
int SetXPath(QString qsXPath);

Default Value

Remarks

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:


'name'	A particular element name
name[i]	The i-th subelement of the current element with the given name
[i]	The i-th subelement of the current element
[last()]	The last subelement of the current element
[last()-i]	The subelement located at the last location minus i in the current element
name[@attrname="attrvalue"]	The subelement containing a particular value for a given attribute (supports single AND double quotes)
..	The parent of the current element

BuildDOM must be set to True before parsing the document for the XPath functionality to be available.

Example. Setting XPath:


Document root	XML.XPath = "/"
Specific Element	XML.XPath = "/root/SubElement1/SubElement2/"
i-th Child	XML.XPath = "/root/SubElement1[i]"

Data Type

String

XPrefix Property (XML Class)

This property includes the prefix of the current element.

Syntax

ANSI (Cross Platform)
char* GetXPrefix();
int SetXPrefix(const char* lpszXPrefix);

Unicode (Windows)
LPWSTR GetXPrefix();
INT SetXPrefix(LPCWSTR lpszXPrefix);

char* ipworks_xml_getxprefix(void* lpObj);
int ipworks_xml_setxprefix(void* lpObj, const char* lpszXPrefix);

QString GetXPrefix();
int SetXPrefix(QString qsXPrefix);

Default Value

Remarks

The current element is specified through the XPath property.

Data Type

String

XSubTree Property (XML Class)

This property includes a snapshot of the current element in the document.

Syntax

ANSI (Cross Platform)
char* GetXSubTree();

Unicode (Windows)
LPWSTR GetXSubTree();

char* ipworks_xml_getxsubtree(void* lpObj);

QString GetXSubTree();

Default Value

Remarks

The current element is specified through the XPath property. For this property to work, you must set the CacheContent to True.

This property is read-only.

Data Type

String

XText Property (XML Class)

This property includes the text of the current element.

Syntax

ANSI (Cross Platform)
char* GetXText();
int SetXText(const char* lpszXText);

Unicode (Windows)
LPWSTR GetXText();
INT SetXText(LPCWSTR lpszXText);

char* ipworks_xml_getxtext(void* lpObj);
int ipworks_xml_setxtext(void* lpObj, const char* lpszXText);

QString GetXText();
int SetXText(QString qsXText);

Default Value

Remarks

The current element is specified through the XPath property.

Data Type

String

Config Method (XML Class)

Sets or retrieves a configuration setting.

Syntax

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworks_xml_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

EndElement Method (XML Class)

This method writes the closing tag of an open XML element.

Syntax

ANSI (Cross Platform)
int EndElement();

Unicode (Windows)
INT EndElement();

int ipworks_xml_endelement(void* lpObj);

int EndElement();

Remarks

This method writes the closing tag of the XML element most recently opened using StartElement.

If no elements are opened, the call fails with an error

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Flush Method (XML Class)

This method flushes the parser and checks its end state.

Syntax

ANSI (Cross Platform)
int Flush();

Unicode (Windows)
INT Flush();

int ipworks_xml_flush(void* lpObj);

int Flush();

Remarks

When Flush is called, the parser flushes all its buffers, firing events as necessary, and then checks its end state. If Validate is True, the parser verifies that all open elements were closed, returning an error if not.

Error Handling (C++)

GetAttr Method (XML Class)

This method returns the value of the specified attribute.

Syntax

ANSI (Cross Platform)
char* GetAttr(const char* lpszAttrName);

Unicode (Windows)
LPWSTR GetAttr(LPCWSTR lpszAttrName);

char* ipworks_xml_getattr(void* lpObj, const char* lpszAttrName);

QString GetAttr(const QString& qsAttrName);

Remarks

This method returns the value of the attribute specified by the AttrName parameter.

If the attribute does not exist, an empty string is returned. The behavior when an attribute does not exit is controlled by ErrorOnEmptyAttr.

Please refer to the Name, Namespace, Prefix, and Value properties for more information.

Error Handling (C++)

HasXPath Method (XML Class)

This method determines whether a specific element exists in the document.

Syntax

ANSI (Cross Platform)
bool HasXPath(const char* lpszXPath);

Unicode (Windows)
INT HasXPath(LPCWSTR lpszXPath);

bool ipworks_xml_hasxpath(void* lpObj, const char* lpszXPath);

bool HasXPath(const QString& qsXPath);

Remarks

This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it through XPath.

This method returns True if the xpath exists, and False if not.

See XPath for details on the XPath syntax.

Error Handling (C++)

This method returns a Boolean value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

LoadDOM Method (XML Class)

This method loads the document object model (DOM) from a file.

Syntax

ANSI (Cross Platform)
int LoadDOM(const char* lpszFileName);

Unicode (Windows)
INT LoadDOM(LPCWSTR lpszFileName);

int ipworks_xml_loaddom(void* lpObj, const char* lpszFileName);

int LoadDOM(const QString& qsFileName);

Remarks

The LoadDOM method loads a DOM structure previously saved by SaveDOM from the file specified in FileName.

Please refer to the SaveDOM method for more information.

Error Handling (C++)

LoadSchema Method (XML Class)

This method loads the XML schema.

Syntax

ANSI (Cross Platform)
int LoadSchema(const char* lpszSchema);

Unicode (Windows)
INT LoadSchema(LPCWSTR lpszSchema);

int ipworks_xml_loadschema(void* lpObj, const char* lpszSchema);

int LoadSchema(const QString& qsSchema);

Remarks

This functionality is not yet implemented.

This method loads the schema specified in the Schema parameter. The Schema may be specified as either a string or the path to a file on disk.

The class will validate the input data during parsing to verify whether or not it adheres to the schema.

Error Handling (C++)

Parse Method (XML Class)

This method parses the specified XML data.

Syntax

ANSI (Cross Platform)
int Parse();

Unicode (Windows)
INT Parse();

int ipworks_xml_parse(void* lpObj);

int Parse();

Remarks

This method parses the specified XML data.

Events are fired only when qualifying conditions (e.g., the beginning of a new element) are met. In the meantime, text will be buffered internally. The following events will fire during parsing:

Characters
Comment
EndElement
EndPrefixMapping
EvalEntity
IgnorableWhitespace
Meta
PI
SpecialSection
StartElement
StartPrefixMapping

If BuildDOM is True (default), XPath may be set after this method returns. XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:


'name'	A particular element name
name[i]	The i-th subelement of the current element with the given name
[i]	The i-th subelement of the current element
[last()]	The last subelement of the current element
[last()-i]	The subelement located at the last location minus i in the current element
name[@attrname="attrvalue"]	The subelement containing a particular value for a given attribute (supports single AND double quotes)
..	The parent of the current element

BuildDOM must be set to True before parsing the document for the XPath functionality to be available.

Example. Setting XPath:


Document root	XML.XPath = "/"
Specific Element	XML.XPath = "/root/SubElement1/SubElement2/"
i-th Child	XML.XPath = "/root/SubElement1[i]"

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

InputFile
InputData

When a valid source is found, the search stops.

If parsing multiple documents, call Reset between documents to reset the parser.

Error Handling (C++)

PutAttr Method (XML Class)

This method writes an XML attribute.

Syntax

ANSI (Cross Platform)
int PutAttr(const char* lpszName, const char* lpszNamespaceURI, const char* lpszValue);

Unicode (Windows)
INT PutAttr(LPCWSTR lpszName, LPCWSTR lpszNamespaceURI, LPCWSTR lpszValue);

int ipworks_xml_putattr(void* lpObj, const char* lpszName, const char* lpszNamespaceURI, const char* lpszValue);

int PutAttr(const QString& qsName, const QString& qsNamespaceURI, const QString& qsValue);

Remarks

This method writes an XML attribute on the currently opened XML element. It must be called right after calling StartElement and before any calls to PutString, PutComment, or PutRaw.

If Name is a local name without a prefix, the class will automatically introduce a new xmlns="NamespaceURI" attribute, if necessary.

If Name is in the form prefix:local, then class will automatically introduce a new xmlns:prefix="NamespaceURI" as necessary.

Certain attribute names will be handled in special ways by this method. If Name is "xmlns" or uses the "xmlns" prefix, the attribute will be interpreted as a namespace declaration, regardless of the value of NamespaceURI. Similarly, any attribute using the "xml" prefix will be interpreted as a special attribute (like "xml:lang") and NamespaceURI will be ignored.

Error Handling (C++)

PutCData Method (XML Class)

This method writes an XML CDATA block.

Syntax

ANSI (Cross Platform)
int PutCData(const char* lpszText);

Unicode (Windows)
INT PutCData(LPCWSTR lpszText);

int ipworks_xml_putcdata(void* lpObj, const char* lpszText);

int PutCData(const QString& qsText);

Remarks

This methods writes a new XML CDATA block with the specified text inside the current element.

Error Handling (C++)

PutComment Method (XML Class)

This method writes an XML comment block.

Syntax

ANSI (Cross Platform)
int PutComment(const char* lpszText);

Unicode (Windows)
INT PutComment(LPCWSTR lpszText);

int ipworks_xml_putcomment(void* lpObj, const char* lpszText);

int PutComment(const QString& qsText);

Remarks

This method writes a new XML comment block with the specified text.

Error Handling (C++)

PutElement Method (XML Class)

This method writes a simple XML element with a value.

Syntax

ANSI (Cross Platform)
int PutElement(const char* lpszName, const char* lpszNamespaceURI, const char* lpszValue);

Unicode (Windows)
INT PutElement(LPCWSTR lpszName, LPCWSTR lpszNamespaceURI, LPCWSTR lpszValue);

int ipworks_xml_putelement(void* lpObj, const char* lpszName, const char* lpszNamespaceURI, const char* lpszValue);

int PutElement(const QString& qsName, const QString& qsNamespaceURI, const QString& qsValue);

Remarks

This method writes a simple XML element with no attributes and the specified value between the opening and closing tags.

If Name is a local name without a prefix, the class will automatically introduce a new xmlns="NamespaceURI" attribute, if necessary.

If Name is in the form prefix:local, then class will automatically introduce a new xmlns:prefix="NamespaceURI" as necessary.

When calling PutElement or StartElement, if a NamespaceURI is not specified, an empty namespace will be defined for the element. If a namespace should be associated with the element, a NamespaceURI value must be provided. When creating the XML, the class will determine if the namespace already exists to avoid duplicate definitions of the same namespace. For example, to create this XML:

<book xmlns='urn:loc.gov:books'
      xmlns:isbn='urn:ISBN:0-395-36341-6'>
    <title>Cheaper by the Dozen</title>
    <isbn:number>1568491379</isbn:number>
</book>

Use the following code:

xml.StartElement("book", "urn:loc.gov:books");
xml.PutAttr("xmlns:isbn", "", "urn:ISBN:0-395-36341-6");
xml.PutElement("title", "urn:loc.gov:books", "Cheaper by the Dozen");
xml.PutElement("isbn:number", "urn:ISBN:0-395-36341-6", "1568491379");
xmlw.Close();

In this example, the "title" element uses the default namespace "urn:loc.gov:books" and the "number" element uses the "urn:ISBN:0-395-36341-6" namespace as defined for the "isbn" prefix.

Error Handling (C++)

PutRaw Method (XML Class)

This method writes a raw XML fragment.

Syntax

ANSI (Cross Platform)
int PutRaw(const char* lpszText);

Unicode (Windows)
INT PutRaw(LPCWSTR lpszText);

int ipworks_xml_putraw(void* lpObj, const char* lpszText);

int PutRaw(const QString& qsText);

Remarks

This method writes a raw XML fragment to the output, without escaping and without verification. If an XML element opening tag has been written before the raw fragment, the fragment will be written as a child of the current element.

Use of this method should be carefully considered as it can easily lead to malformed XML content.

Error Handling (C++)

PutString Method (XML Class)

This method writes text inside an XML element.

Syntax

ANSI (Cross Platform)
int PutString(const char* lpszText);

Unicode (Windows)
INT PutString(LPCWSTR lpszText);

int ipworks_xml_putstring(void* lpObj, const char* lpszText);

int PutString(const QString& qsText);

Remarks

This method will XML escape the value provided and write the resulting escaped text between the opening and closing tags of an XML element.

Error Handling (C++)

RemoveAttr Method (XML Class)

This method removes an attribute.

Syntax

ANSI (Cross Platform)
int RemoveAttr(const char* lpszAttrName);

Unicode (Windows)
INT RemoveAttr(LPCWSTR lpszAttrName);

int ipworks_xml_removeattr(void* lpObj, const char* lpszAttrName);

int RemoveAttr(const QString& qsAttrName);

Remarks

This method removes an attribute at the specified XPath

This functionality is not yet implemented.

Error Handling (C++)

RemoveChildren Method (XML Class)

This method removes the children of the element as the specified XPath.

Syntax

ANSI (Cross Platform)
int RemoveChildren();

Unicode (Windows)
INT RemoveChildren();

int ipworks_xml_removechildren(void* lpObj);

int RemoveChildren();

Remarks

This method removes the children of the element specified by XPath.

When called, the class will remove the children of the element from the internal representation of the XML (the DOM). The element itself remains, with no children. This may be used at any time after Parse returns, or from within the EndElement event as a document is parsed to remove sections of a document that will not be needed later. By removing unnecessary elements from the DOM, memory consumption is reduced and overall performance is improved.

Example. RemoveChildren:

Given the XML

<food>
	<fruits>
		<apple>
			<color>red</color>
		</apple>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

This code removes the children of the apple element while leaving the apple element in place.

xml.XPath = "/food/fruits/apple"; xml.RemoveChildren();

The XML stored in the DOM is now:

<food>
	<fruits>
		<apple>
		</apple>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

Error Handling (C++)

RemoveElement Method (XML Class)

This method removes the element as the specified XPath.

Syntax

ANSI (Cross Platform)
int RemoveElement();

Unicode (Windows)
INT RemoveElement();

int ipworks_xml_removeelement(void* lpObj);

int RemoveElement();

Remarks

This method removes the element specified by XPath.

When called, the class will remove the element and its children from the internal representation of the XML (the DOM). This may be used at any time after Parse returns, or from within the EndElement event as a document is parsed to remove sections of a document that will not be needed later. By removing unnecessary elements from the DOM, memory consumption is reduced and overall performance is improved.

Example. RemoveElement:

Given the XML

<food>
	<fruits>
		<apple>
			<color>red</color>
		</apple>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

This code removes the apple element and its children.

xml.XPath = "/food/fruits/apple"; xml.RemoveElement();

The XML stored in the DOM is now:

<food>
	<fruits>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

Error Handling (C++)

Reset Method (XML Class)

This method resets the parser.

Syntax

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworks_xml_reset(void* lpObj);

int Reset();

Remarks

When called, the parser flushes all its buffers, firing events as necessary, and then initializes itself to its default state.

Reset must also be used as signal to the parser that the current stream of text has terminated.

Error Handling (C++)

Save Method (XML Class)

This method closes the class writing stream.

Syntax

ANSI (Cross Platform)
int Save();

Unicode (Windows)
INT Save();

int ipworks_xml_save(void* lpObj);

int Save();

Remarks

This method will close any open XML elements, and then close the OutputFile if necessary.

Error Handling (C++)

SaveDOM Method (XML Class)

This method saves the DOM to a file.

Syntax

ANSI (Cross Platform)
int SaveDOM(const char* lpszFileName);

Unicode (Windows)
INT SaveDOM(LPCWSTR lpszFileName);

int ipworks_xml_savedom(void* lpObj, const char* lpszFileName);

int SaveDOM(const QString& qsFileName);

Remarks

The SaveDOM method saves the current DOM structure to the file specified in FileName. This enables the component to later load the DOM without incurring any parsing overhead.

Please refer to the LoadDOM method for more information.

Error Handling (C++)

SetInputStream Method (XML Class)

This method sets the stream from which the class will read data to parse.

Syntax

ANSI (Cross Platform)
int SetInputStream(IPWorksStream* sInputStream);

Unicode (Windows)
INT SetInputStream(IPWorksStream* sInputStream);

int ipworks_xml_setinputstream(void* lpObj, IPWorksStream* sInputStream);

int SetInputStream(IPWorksStream* sInputStream);

Remarks

This method specifies a stream from which data will be read when Parse is called.

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

InputFile
InputData

When a valid source is found, the search stops.

Error Handling (C++)

SetOutputStream Method (XML Class)

This method sets the stream to which the class will write the XML.

Syntax

ANSI (Cross Platform)
int SetOutputStream(IPWorksStream* sOutputStream);

Unicode (Windows)
INT SetOutputStream(IPWorksStream* sOutputStream);

int ipworks_xml_setoutputstream(void* lpObj, IPWorksStream* sOutputStream);

int SetOutputStream(IPWorksStream* sOutputStream);

Remarks

This method sets the stream to which output will be written when writing data.

Output Properties

The class will determine the destination of the output based on which properties are set.

The order in which the output properties are checked is as follows:

OutputFile
OutputData: The output data are written to this property if no other destination is specified.

Error Handling (C++)

StartElement Method (XML Class)

This method writes the opening tag of an XML element.

Syntax

ANSI (Cross Platform)
int StartElement(const char* lpszName, const char* lpszNamespaceURI);

Unicode (Windows)
INT StartElement(LPCWSTR lpszName, LPCWSTR lpszNamespaceURI);

int ipworks_xml_startelement(void* lpObj, const char* lpszName, const char* lpszNamespaceURI);

int StartElement(const QString& qsName, const QString& qsNamespaceURI);

Remarks

This method writes the opening tag of a new XML element. If an XML element is already opened, then this element is written as a child.

If Name is a local name without a prefix, the class will automatically introduce a new xmlns="NamespaceURI" attribute, if necessary.

If Name is in the form prefix:local, then class will automatically introduce a new xmlns:prefix="NamespaceURI" as necessary.

<book xmlns='urn:loc.gov:books'
      xmlns:isbn='urn:ISBN:0-395-36341-6'>
    <title>Cheaper by the Dozen</title>
    <isbn:number>1568491379</isbn:number>
</book>

Use the following code:

xml.StartElement("book", "urn:loc.gov:books");
xml.PutAttr("xmlns:isbn", "", "urn:ISBN:0-395-36341-6");
xml.PutElement("title", "urn:loc.gov:books", "Cheaper by the Dozen");
xml.PutElement("isbn:number", "urn:ISBN:0-395-36341-6", "1568491379");
xmlw.Close();

In this example, the "title" element uses the default namespace "urn:loc.gov:books" and the "number" element uses the "urn:ISBN:0-395-36341-6" namespace as defined for the "isbn" prefix.

Error Handling (C++)

TryXPath Method (XML Class)

This method navigates to the specified XPath if it exists.

Syntax

ANSI (Cross Platform)
bool TryXPath(const char* lpszxpath);

Unicode (Windows)
INT TryXPath(LPCWSTR lpszxpath);

bool ipworks_xml_tryxpath(void* lpObj, const char* lpszxpath);

bool TryXPath(const QString& qsxpath);

Remarks

This method will attempt to navigate to the specified XPath parameter if it exists within the document.

If the XPath exists, the XPath property will be updated and this method returns True.

If the XPath does not exist, the XPath property is not updated and this method returns False.

Error Handling (C++)

Characters Event (XML Class)

This event is fired for plaintext segments of the input stream.

Syntax

ANSI (Cross Platform)
virtual int FireCharacters(XMLCharactersEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} XMLCharactersEventParams;


Unicode (Windows)
virtual INT FireCharacters(XMLCharactersEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} XMLCharactersEventParams;

#define EID_XML_CHARACTERS 1

virtual INT IPWORKS_CALL FireCharacters(LPSTR &lpszText);

class XMLCharactersEventParams {
public:
  const QString &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Characters(XMLCharactersEventParams *e);

// Or, subclass XML and override this emitter function.
virtual int FireCharacters(XMLCharactersEventParams *e) {...}

Remarks

The Characters event provides the plaintext content of the XML document (i.e., the text inside the tags). The text is provided through the Text parameter.

The text includes white space as well as end-of-line characters, except for ignorable whitespace, which is fired through the IgnorableWhitespace event.

Comment Event (XML Class)

This event is fired when a comment section is encountered.

Syntax

ANSI (Cross Platform)
virtual int FireComment(XMLCommentEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} XMLCommentEventParams;


Unicode (Windows)
virtual INT FireComment(XMLCommentEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} XMLCommentEventParams;

#define EID_XML_COMMENT 2

virtual INT IPWORKS_CALL FireComment(LPSTR &lpszText);

class XMLCommentEventParams {
public:
  const QString &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Comment(XMLCommentEventParams *e);

// Or, subclass XML and override this emitter function.
virtual int FireComment(XMLCommentEventParams *e) {...}

Remarks

The Comment event is fired whenever a comment section () is found in the document.

The full text of the comment is provided by the Text parameter.

EndElement Event (XML Class)

This event is fired when an end-element tag is encountered.

Syntax

ANSI (Cross Platform)
virtual int FireEndElement(XMLEndElementEventParams *e);

typedef struct {
  const char *Namespace;
  const char *Element;
  const char *QName;
  int IsEmpty;
  int reserved;
} XMLEndElementEventParams;


Unicode (Windows)
virtual INT FireEndElement(XMLEndElementEventParams *e);

typedef struct {
  LPCWSTR Namespace;
  LPCWSTR Element;
  LPCWSTR QName;
  BOOL IsEmpty;
  INT reserved;
} XMLEndElementEventParams;

#define EID_XML_ENDELEMENT 3

virtual INT IPWORKS_CALL FireEndElement(LPSTR &lpszNamespace, LPSTR &lpszElement, LPSTR &lpszQName, BOOL &bIsEmpty);

class XMLEndElementEventParams {
public:
  const QString &Namespace();

  const QString &Element();

  const QString &QName();

  bool IsEmpty();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndElement(XMLEndElementEventParams *e);

// Or, subclass XML and override this emitter function.
virtual int FireEndElement(XMLEndElementEventParams *e) {...}

Remarks

The EndElement event is fired when an end-element tag is found in the document.

The element name is provided by the Element parameter.

The IsEmpty parameter is true when the event corresponds to an empty element declaration.

EndPrefixMapping Event (XML Class)

This event is fired when leaving the scope of a namespace declaration.

Syntax

ANSI (Cross Platform)
virtual int FireEndPrefixMapping(XMLEndPrefixMappingEventParams *e);

typedef struct {
  const char *Prefix;
  int reserved;
} XMLEndPrefixMappingEventParams;


Unicode (Windows)
virtual INT FireEndPrefixMapping(XMLEndPrefixMappingEventParams *e);

typedef struct {
  LPCWSTR Prefix;
  INT reserved;
} XMLEndPrefixMappingEventParams;

#define EID_XML_ENDPREFIXMAPPING 4

virtual INT IPWORKS_CALL FireEndPrefixMapping(LPSTR &lpszPrefix);

class XMLEndPrefixMappingEventParams {
public:
  const QString &Prefix();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndPrefixMapping(XMLEndPrefixMappingEventParams *e);

// Or, subclass XML and override this emitter function.
virtual int FireEndPrefixMapping(XMLEndPrefixMappingEventParams *e) {...}

Remarks

The StartPrefixMapping event is fired when entering the scope of a namespace declaration.

Error Event (XML Class)

Fired when information is available about errors during data delivery.

Syntax

ANSI (Cross Platform)
virtual int FireError(XMLErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} XMLErrorEventParams;


Unicode (Windows)
virtual INT FireError(XMLErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} XMLErrorEventParams;

#define EID_XML_ERROR 5

virtual INT IPWORKS_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class XMLErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(XMLErrorEventParams *e);

// Or, subclass XML and override this emitter function.
virtual int FireError(XMLErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

EvalEntity Event (XML Class)

This event is fired every time an entity needs to be evaluated.

Syntax

ANSI (Cross Platform)
virtual int FireEvalEntity(XMLEvalEntityEventParams *e);

typedef struct {
  const char *Entity;
  char *Value;
  int reserved;
} XMLEvalEntityEventParams;


Unicode (Windows)
virtual INT FireEvalEntity(XMLEvalEntityEventParams *e);

typedef struct {
  LPCWSTR Entity;
  LPWSTR Value;
  INT reserved;
} XMLEvalEntityEventParams;

#define EID_XML_EVALENTITY 6

virtual INT IPWORKS_CALL FireEvalEntity(LPSTR &lpszEntity, LPSTR &lpszValue);

class XMLEvalEntityEventParams {
public:
  const QString &Entity();

  const QString &Value();
  void SetValue(const QString &qsValue);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EvalEntity(XMLEvalEntityEventParams *e);

// Or, subclass XML and override this emitter function.
virtual int FireEvalEntity(XMLEvalEntityEventParams *e) {...}

Remarks

The Value parameter contains a suggested value for the entity (normally the entity name itself). You may set Value to a value of your choice, which will be later passed into the text stream.

IgnorableWhitespace Event (XML Class)

This event is fired when a section of ignorable whitespace is encountered.

Syntax

ANSI (Cross Platform)
virtual int FireIgnorableWhitespace(XMLIgnorableWhitespaceEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} XMLIgnorableWhitespaceEventParams;


Unicode (Windows)
virtual INT FireIgnorableWhitespace(XMLIgnorableWhitespaceEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} XMLIgnorableWhitespaceEventParams;

#define EID_XML_IGNORABLEWHITESPACE 7

virtual INT IPWORKS_CALL FireIgnorableWhitespace(LPSTR &lpszText);

class XMLIgnorableWhitespaceEventParams {
public:
  const QString &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void IgnorableWhitespace(XMLIgnorableWhitespaceEventParams *e);

// Or, subclass XML and override this emitter function.
virtual int FireIgnorableWhitespace(XMLIgnorableWhitespaceEventParams *e) {...}

Remarks

The ignorable whitespace section is provided by the Text parameter.

Meta Event (XML Class)

This event fires when a meta section is encountered.

Syntax

ANSI (Cross Platform)
virtual int FireMeta(XMLMetaEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} XMLMetaEventParams;


Unicode (Windows)
virtual INT FireMeta(XMLMetaEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} XMLMetaEventParams;

#define EID_XML_META 8

virtual INT IPWORKS_CALL FireMeta(LPSTR &lpszText);

class XMLMetaEventParams {
public:
  const QString &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Meta(XMLMetaEventParams *e);

// Or, subclass XML and override this emitter function.
virtual int FireMeta(XMLMetaEventParams *e) {...}

Remarks

The Meta event is fired whenever a meta information section (<! ..text... >) is found in the document.

The full text of the meta section is provided by the Text parameter.

PI Event (XML Class)

This event is fired when a processing instruction section is encountered.

Syntax

ANSI (Cross Platform)
virtual int FirePI(XMLPIEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} XMLPIEventParams;


Unicode (Windows)
virtual INT FirePI(XMLPIEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} XMLPIEventParams;

#define EID_XML_PI 9

virtual INT IPWORKS_CALL FirePI(LPSTR &lpszText);

class XMLPIEventParams {
public:
  const QString &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PI(XMLPIEventParams *e);

// Or, subclass XML and override this emitter function.
virtual int FirePI(XMLPIEventParams *e) {...}

Remarks

The PI event is fired whenever a processing instruction section (<? ..text... ?>) is found in the document.

The full text of the processing instruction is provided by the Text parameter.

SpecialSection Event (XML Class)

This event is fired when a special section is encountered.

Syntax

ANSI (Cross Platform)
virtual int FireSpecialSection(XMLSpecialSectionEventParams *e);

typedef struct {
  const char *SectionId;
  const char *Text;
  int reserved;
} XMLSpecialSectionEventParams;


Unicode (Windows)
virtual INT FireSpecialSection(XMLSpecialSectionEventParams *e);

typedef struct {
  LPCWSTR SectionId;
  LPCWSTR Text;
  INT reserved;
} XMLSpecialSectionEventParams;

#define EID_XML_SPECIALSECTION 10

virtual INT IPWORKS_CALL FireSpecialSection(LPSTR &lpszSectionId, LPSTR &lpszText);

class XMLSpecialSectionEventParams {
public:
  const QString &SectionId();

  const QString &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SpecialSection(XMLSpecialSectionEventParams *e);

// Or, subclass XML and override this emitter function.
virtual int FireSpecialSection(XMLSpecialSectionEventParams *e) {...}

Remarks

The SpecialSection event is fired whenever a special section (such as <![ CDATA [ ..text... ]]>) is found in the document.

The full text of the special section is provided by the Text parameter, and the SectionId parameter provides the section identifier (e.g., CDATA).

StartElement Event (XML Class)

This event is fired when a begin-element tag is encountered in the document.

Syntax

ANSI (Cross Platform)
virtual int FireStartElement(XMLStartElementEventParams *e);

typedef struct {
  const char *Namespace;
  const char *Element;
  const char *QName;
  int IsEmpty;
  int reserved;
} XMLStartElementEventParams;


Unicode (Windows)
virtual INT FireStartElement(XMLStartElementEventParams *e);

typedef struct {
  LPCWSTR Namespace;
  LPCWSTR Element;
  LPCWSTR QName;
  BOOL IsEmpty;
  INT reserved;
} XMLStartElementEventParams;

#define EID_XML_STARTELEMENT 11

virtual INT IPWORKS_CALL FireStartElement(LPSTR &lpszNamespace, LPSTR &lpszElement, LPSTR &lpszQName, BOOL &bIsEmpty);

class XMLStartElementEventParams {
public:
  const QString &Namespace();

  const QString &Element();

  const QString &QName();

  bool IsEmpty();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartElement(XMLStartElementEventParams *e);

// Or, subclass XML and override this emitter function.
virtual int FireStartElement(XMLStartElementEventParams *e) {...}

Remarks

The StartElement event is fired when a begin-element tag is found in the document.

The element name is provided through the Element parameter. The attribute names and values (if any) are provided through the Name, Namespace, Prefix, and Value properties.

The IsEmpty parameter is True when the event corresponds to an empty element declaration.

StartPrefixMapping Event (XML Class)

This event is fired when entering the scope of a namespace declaration.

Syntax

ANSI (Cross Platform)
virtual int FireStartPrefixMapping(XMLStartPrefixMappingEventParams *e);

typedef struct {
  const char *Prefix;
  const char *URI;
  int reserved;
} XMLStartPrefixMappingEventParams;


Unicode (Windows)
virtual INT FireStartPrefixMapping(XMLStartPrefixMappingEventParams *e);

typedef struct {
  LPCWSTR Prefix;
  LPCWSTR URI;
  INT reserved;
} XMLStartPrefixMappingEventParams;

#define EID_XML_STARTPREFIXMAPPING 12

virtual INT IPWORKS_CALL FireStartPrefixMapping(LPSTR &lpszPrefix, LPSTR &lpszURI);

class XMLStartPrefixMappingEventParams {
public:
  const QString &Prefix();

  const QString &URI();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartPrefixMapping(XMLStartPrefixMappingEventParams *e);

// Or, subclass XML and override this emitter function.
virtual int FireStartPrefixMapping(XMLStartPrefixMappingEventParams *e) {...}

Remarks

The EndPrefixMapping event is fired when leaving the scope of a namespace declaration.

XML Event (XML Class)

This event is fired as XML is written.

Syntax

ANSI (Cross Platform)
virtual int FireXML(XMLXMLEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} XMLXMLEventParams;


Unicode (Windows)
virtual INT FireXML(XMLXMLEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} XMLXMLEventParams;

#define EID_XML_XML 13

virtual INT IPWORKS_CALL FireXML(LPSTR &lpszText);

class XMLXMLEventParams {
public:
  const QString &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void XMLEvt(XMLXMLEventParams *e);

// Or, subclass XML and override this emitter function.
virtual int FireXML(XMLXMLEventParams *e) {...}

Remarks

This event is fired when XML is output. The Text parameter holds the data being written.

This functionality is not yet implemented.

XMLAttribute Type

This type describes an XML attribute from the current XML element.

Syntax

IPWorksXMLAttribute (declared in ipworks.h)

Remarks

This type describes an XML attribute from the current element. It includes fields to denote information about the attribute being defined.

The following fields are available:

Fields

Name
char* (read-only)
Default Value: ""

The Name provides the local name (without prefix) of the attribute.

Namespace
char* (read-only)
Default Value: ""

This field contains the attribute namespace.

Prefix
char* (read-only)
Default Value: ""

This field contains the attribute prefix (if any). If the attribute does not have a prefix, this property is empty.

Value
char* (read-only)
Default Value: ""

This field contains the attribute value.

Constructors

XMLAttribute()

XMLComment Type

This types holds a comment within the document.

Syntax

IPWorksXMLComment (declared in ipworks.h)

Remarks

This type holds a comment within the XML document.

The following fields are available:

Text

Fields

Text
char*
Default Value: ""

This field holds the comment text.

Constructors

XMLComment()

XMLComment(const char* lpszText)

XMLDeclaration Type

This types includes the XML declaration present at the beginning of a document.

Syntax

IPWorksXMLDeclaration (declared in ipworks.h)

Remarks

This type contains details about the XML declaration, which may be set before writing a document. This is applicable only when writing documents.

The following fields are available:

Encoding

Standalone

Version

Fields

Encoding
char*
Default Value: "utf-8"

This field specifies the XML encoding to use.

This may be set before writing a document. The default value is UTF-8.

This is applicable only when writing XML.

Standalone
int
Default Value: TRUE

This field indicates whether the standalone attribute is present in the declaration with a value of True.

This may be set before writing a document. The default value is True.

This is applicable only when writing XML.

Version
char*
Default Value: "1.0"

This field specifies the XML version.

This may be set before writing a document. The default value is 1.0.

This is applicable only when writing XML.

Constructors

XMLDeclaration()

XMLDeclaration(const char* lpszVersion, const char* lpszEncoding, int bStandalone)

XMLElement Type

This type describes an element contained within the XML document.

Syntax

IPWorksXMLElement (declared in ipworks.h)

Remarks

This type describes an XML element. The fields for this type describe the element Name, Prefix, and Namespace of the given element.

The elements are inserted into the array in the same order they are found in the document.

The following fields are available:

Fields

Name
char* (read-only)
Default Value: ""

The Name field provides the local name (without a prefix) of the element.

Namespace
char* (read-only)
Default Value: ""

This field contains the namespace of the element.

Prefix
char* (read-only)
Default Value: ""

This field contains the prefix of the element (if any). If the element does not have a prefix, this property is empty.

XText
char* (read-only)
Default Value: ""

This field contains the inner text of the element.

Constructors

XMLElement()

XMLNamespace Type

This type describes an XML namespace from the current namespace stack.

Syntax

IPWorksXMLNamespace (declared in ipworks.h)

Remarks

This type describes an XML namespace from the current stack. It includes fields to denote the Prefix and the URI of the namespace being defined.

The default namespace exists at index 0. The Prefix field at index 0 is xmlns, and the Name field contains the default namespace.

The following fields are available:

Prefix

URI

Fields

Prefix
char*
Default Value: ""

This field contains the Prefix for the Namespace.

URI
char*
Default Value: ""

This field contains the namespace URI associated with the corresponding Prefix. This URL is usually pointing to the XML schema for the namespace.

Constructors

XMLNamespace()

XMLNamespace(const char* lpszURI, const char* lpszPrefix)

IPWorksList Type

Syntax

IPWorksList<T> (declared in ipworks.h)

Remarks

IPWorksList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the XML class.

Methods

GetCount	This method returns the current size of the collection. int GetCount() {}
SetCount	This method sets the size of the collection. This method returns `0` if setting the size was successful; or `-1` if the collection is `ReadOnly`. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. int SetCount(int count) {}
Get	This method gets the item at the specified position. The `index` parameter specifies the index of the item in the collection. This method returns `NULL` if an invalid `index` is specified. T* Get(int index) {}
Set	This method sets the item at the specified position. The `index` parameter specifies the index of the item in the collection that is being set. This method returns `-1` if an invalid `index` is specified. Note: Objects created using the `new` operator must be freed using the `delete` operator; they will not be automatically freed by the class. T* Set(int index, T* value) {}

IPWorksStream Type

Syntax

IPWorksStream (declared in ipworks.h)

Remarks

The XML class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksStream interface and pass the XML class an instance of that concrete class.

When implementing the IPWorksStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.

Properties

CanRead	Whether the stream supports reading. bool CanRead() { return true; }
CanSeek	Whether the stream supports seeking. bool CanSeek() { return true; }
CanWrite	Whether the stream supports writing. bool CanWrite() { return true; }
Length	Gets the length of the stream, in bytes. int64 GetLength() = 0;
Methods

Close	Closes the stream, releasing all resources currently allocated for it. void Close() {} This method is called automatically when an IPWorksStream object is deleted.
Flush	Forces all data held by the stream's buffers to be written out to storage. int Flush() { return 0; } Must return `0` if flushing is successful; or `-1` if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return `0`.
Read	Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read. int Read(void* buffer, int count) = 0; `Buffer` specifies the buffer to populate with data from the stream. `Count` specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into `Buffer`; this may be less than `Count` if that many bytes are not currently available, or `0` if the end of the stream has been reached. Must return `-1` if an error occurs, if reading is not supported, or if the stream is closed.
Seek	Sets the current position within the stream based on a particular point of origin. int64 Seek(int64 offset, int seekOrigin) = 0; `Offset` specifies the offset in the stream to seek to, relative to `SeekOrigin`. Valid values for `SeekOrigin` are: `0`: Seek from beginning. `1`: Seek from current position. `2`: Seek from end. Must return the new position within the stream; or `-1` if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If `-1` is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an `Offset` of `0` and a `SeekOrigin` of `1` to obtain the current position within the stream, even if seeking is not otherwise supported.
Write	Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written. int Write(const void* buffer, int count) = 0; `Buffer` specifies the buffer with data to write to the stream. `Count` specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than `Count` if that many bytes could not be written. Must return `-1` if an error occurs, if writing is not supported, or if the stream is closed.

Config Settings (XML Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

XML Config Settings

CacheContent: If true, the original XML is saved in a buffer.

This configuration setting controls whether or not the component retains the entire original XML in a buffer. This is used to retain the original XML as opposed to returning generated XML after parsing. The default value is True.

Charset: Specifies the charset used when encoding data.

This configuration setting specifies the character set used when encoding data. This value will also be used when creating the XMLDeclaration. The default value is "utf-8".

EOL: The characters to use for separating lines.

If specified, the class will format the output XML, using the specified characters to separate multiple lines for nested XML elements. The default value is CRLF ("\r\n") .

This option should be combined with Indent for full effect.

ErrorOnEmptyAttr: If true, passing an invalid attribute to the Attr method will throw an exception.

If an invalid attribute name is passed into the GetAttr method, the method will return with an empty string if this is set to False; otherwise, an exception is thrown.

ExtraNameChars: Extra characters for the parser to consider as name characters.

Normally, the parser considers only the following characters as part of an XML identifier: 'A' through 'Z', 'a' through 'z', '0' through '9', and '.', '-', '_', ':'.

If you would like any other characters to be considered as name characters, you may set them as a string into this property.

ExtraSpaceChars: Extra characters for the parser to consider as white space.

Normally, the parser considers only the following characters as white space: ' ' (space), '\t' (tab), '\ n' (newline), '\r' (carriage return), '\f' (form feed), and '\v' (vertical tab).

If you would like any other characters to be considered as white space, you may set them as a string into this property.

FlushOnEOL: If set, the parser flushes its text buffer after every line of text.

The FlushOnEOL property controls whether or not Characters events are fired for every line of the input text stream. Normally, lines are buffered internally and delivered in batches, but if the FlushOnEOL flag is set, then a Characters event is fired for each line.

IgnoreBadAttributePrefixes: If true, bad (unknown) attribute prefixes are ignored.

Normally a trappable error is generated when an unknown attribute prefix is encountered. This configuration setting suppresses the error. The default value is True.

IgnoreBadElementPrefixes: If true, bad (unknown) element prefixes are ignored.

Normally a trappable error is generated when an unknown element prefix is encountered. This configuration setting suppresses the error. The default value is True.

IncludeElementPrefix: Whether to include the prefix in the element name.

This configuration setting specifies whether or not to include the element prefix in the Element parameter of the StartElement and EndElement events.

If False (default) and Validate is set to False, the prefix is included in the Element parameter (e.g., ds:DigestMethod).

If True and Validate is set to False, the prefix is not included in the Element parameter (e.g., DigestMethod).

This setting is applicable only when Validate is False.

IncludeXMLDeclaration: Whether to include the XML declaration when writing XML.

This configuration setting specifies whether the XML declaration is included in the output XML when writing XML. When set to True (default), the XML declaration will be included above any user-specified XML. For instance:

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
...

Indent: The characters to use for each indentation level.

If specified, the class will format the output XML, using the specified characters to denote each indentation level for nested XML elements.

This option should be combined with EOL for full effect.

Offset: Current offset of the document being parsed.

This property is useful for determining the location of possible XML errors in the document.

Offset values start at 1.

PreserveWhitespace: If true, leading and trailing whitespace in element text is preserved.

Normally, the leading and trailing whitespace from an element's text is trimmed. When this property is set to True, this leading and trailing whitespace is preserved. The default value is False.

QuoteChar: Quote character to use for attribute values.

By default, the class will use double quotes around attribute values. This property can be used to specify a different character, such as a single quote.

StringProcessingOptions: Defines options to use when processing string values.

This configuration setting determines what additional processing is performed on string values fired through the Characters event.

Note: This applies only when BuildDOM is False.

By default, no additional processing is performed and the string is returned as is from the document. Strings may also be XML unescaped. Possible values are as follows:


0 (none - default)	No additional processing is performed.
1	Strings are XML unescaped.

For instance, when set to 0, the following text may be fired through the Characters event:

&"<>

When set to 1, the following text would be fired through the Characters event:

&"<>

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


Identifier	Name
037	IBM EBCDIC - U.S./Canada
437	OEM - United States
500	IBM EBCDIC - International
708	Arabic - ASMO 708
709	Arabic - ASMO 449+, BCON V4
710	Arabic - Transparent Arabic
720	Arabic - Transparent ASMO
737	OEM - Greek (formerly 437G)
775	OEM - Baltic
850	OEM - Multilingual Latin I
852	OEM - Latin II
855	OEM - Cyrillic (primarily Russian)
857	OEM - Turkish
858	OEM - Multilingual Latin I + Euro symbol
860	OEM - Portuguese
861	OEM - Icelandic
862	OEM - Hebrew
863	OEM - Canadian-French
864	OEM - Arabic
865	OEM - Nordic
866	OEM - Russian
869	OEM - Modern Greek
870	IBM EBCDIC - Multilingual/ROECE (Latin-2)
874	ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875	IBM EBCDIC - Modern Greek
932	ANSI/OEM - Japanese, Shift-JIS
936	ANSI/OEM - Simplified Chinese (PRC, Singapore)
949	ANSI/OEM - Korean (Unified Hangul Code)
950	ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026	IBM EBCDIC - Turkish (Latin-5)
1047	IBM EBCDIC - Latin 1/Open System
1140	IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141	IBM EBCDIC - Germany (20273 + Euro symbol)
1142	IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143	IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144	IBM EBCDIC - Italy (20280 + Euro symbol)
1145	IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146	IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147	IBM EBCDIC - France (20297 + Euro symbol)
1148	IBM EBCDIC - International (500 + Euro symbol)
1149	IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200	Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201	Unicode UCS-2 Big-Endian
1250	ANSI - Central European
1251	ANSI - Cyrillic
1252	ANSI - Latin I
1253	ANSI - Greek
1254	ANSI - Turkish
1255	ANSI - Hebrew
1256	ANSI - Arabic
1257	ANSI - Baltic
1258	ANSI/OEM - Vietnamese
1361	Korean (Johab)
10000	MAC - Roman
10001	MAC - Japanese
10002	MAC - Traditional Chinese (Big5)
10003	MAC - Korean
10004	MAC - Arabic
10005	MAC - Hebrew
10006	MAC - Greek I
10007	MAC - Cyrillic
10008	MAC - Simplified Chinese (GB 2312)
10010	MAC - Romania
10017	MAC - Ukraine
10021	MAC - Thai
10029	MAC - Latin II
10079	MAC - Icelandic
10081	MAC - Turkish
10082	MAC - Croatia
12000	Unicode UCS-4 Little-Endian
12001	Unicode UCS-4 Big-Endian
20000	CNS - Taiwan
20001	TCA - Taiwan
20002	Eten - Taiwan
20003	IBM5550 - Taiwan
20004	TeleText - Taiwan
20005	Wang - Taiwan
20105	IA5 IRV International Alphabet No. 5 (7-bit)
20106	IA5 German (7-bit)
20107	IA5 Swedish (7-bit)
20108	IA5 Norwegian (7-bit)
20127	US-ASCII (7-bit)
20261	T.61
20269	ISO 6937 Non-Spacing Accent
20273	IBM EBCDIC - Germany
20277	IBM EBCDIC - Denmark/Norway
20278	IBM EBCDIC - Finland/Sweden
20280	IBM EBCDIC - Italy
20284	IBM EBCDIC - Latin America/Spain
20285	IBM EBCDIC - United Kingdom
20290	IBM EBCDIC - Japanese Katakana Extended
20297	IBM EBCDIC - France
20420	IBM EBCDIC - Arabic
20423	IBM EBCDIC - Greek
20424	IBM EBCDIC - Hebrew
20833	IBM EBCDIC - Korean Extended
20838	IBM EBCDIC - Thai
20866	Russian - KOI8-R
20871	IBM EBCDIC - Icelandic
20880	IBM EBCDIC - Cyrillic (Russian)
20905	IBM EBCDIC - Turkish
20924	IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932	JIS X 0208-1990 & 0121-1990
20936	Simplified Chinese (GB2312)
21025	IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027	Extended Alpha Lowercase
21866	Ukrainian (KOI8-U)
28591	ISO 8859-1 Latin I
28592	ISO 8859-2 Central Europe
28593	ISO 8859-3 Latin 3
28594	ISO 8859-4 Baltic
28595	ISO 8859-5 Cyrillic
28596	ISO 8859-6 Arabic
28597	ISO 8859-7 Greek
28598	ISO 8859-8 Hebrew
28599	ISO 8859-9 Latin 5
28605	ISO 8859-15 Latin 9
29001	Europa 3
38598	ISO 8859-8 Hebrew
50220	ISO 2022 Japanese with no halfwidth Katakana
50221	ISO 2022 Japanese with halfwidth Katakana
50222	ISO 2022 Japanese JIS X 0201-1989
50225	ISO 2022 Korean
50227	ISO 2022 Simplified Chinese
50229	ISO 2022 Traditional Chinese
50930	Japanese (Katakana) Extended
50931	US/Canada and Japanese
50933	Korean Extended and Korean
50935	Simplified Chinese Extended and Simplified Chinese
50936	Simplified Chinese
50937	US/Canada and Traditional Chinese
50939	Japanese (Latin) Extended and Japanese
51932	EUC - Japanese
51936	EUC - Simplified Chinese
51949	EUC - Korean
51950	EUC - Traditional Chinese
52936	HZ-GB2312 Simplified Chinese
54936	Windows XP: GB18030 Simplified Chinese (4 Byte)
57002	ISCII Devanagari
57003	ISCII Bengali
57004	ISCII Tamil
57005	ISCII Telugu
57006	ISCII Assamese
57007	ISCII Oriya
57008	ISCII Kannada
57009	ISCII Malayalam
57010	ISCII Gujarati
57011	ISCII Punjabi
65000	Unicode UTF-7
65001	Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitiveData: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents: Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

Trappable Errors (XML Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

XML Errors

101	Invalid attribute index.
102	No attributes available.
103	Invalid namespace index.
104	No namespaces available.
105	Invalid element index.
106	No elements available.
107	Attribute does not exist.
201	Unbalanced element tag.
202	Unknown element prefix (cannot find namespace).
203	Unknown attribute prefix (cannot find namespace).
204	Invalid XML markup.
205	Invalid end state for parser.
206	Document contains unbalanced elements.
207	Invalid XPath.
208	No such child.
209	Top element does not match start of path.
210	DOM tree unavailable (set BuildDOM to True and reparse).
302	Cannot open file.
401	Invalid XML would be generated.
402	An invalid XML name has been specified.