%XML_PARSER_PARSESTRING

Parse an XML string

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
document = %XML_PARSER_PARSESTRING(parser, xml_string)

Return value

document

The XML document instance that was created if the parse was successful, or 0 if the parse was not successful. (XML_DOC_TYPE)

Arguments

parser

The parser instance returned by %XML_PARSER_CREATE. (XML_PARSER_TYPE)

xml_string

The XML string instance to parse, as returned by %XML_STRING_CREATE. (XML_STRING_TYPE)

Discussion

%XML_PARSER_PARSESTRING parses well‑formed XML contained in an XML string and returns a new XML document instance. The created document can be processed using the %XML_DOC_xxx routines. The document can be deleted using %XML_DOC_DELETE.

Note

The maximum length of text for an element in an XML document is 65,534 characters. If any element text exceeds this limit, the parser will not return a valid value.

If the XML data to be parsed is in a physical file instead of an XML string, call %XML_PARSER_PARSEFILE instead.

This function is defined as ^VAL.

See also

%XML_OPTION for information about escaping text or attribute values when calling %XML_PARSER_PARSEFILE.

Examples

See PARSEXML.zip, available from the Synergy CodeExchange in the Resource Center on the Synergex website, for an example of how to work around the 65,534 character limit.