SPL::Functions::XML Namespace Reference

C++ counterparts of SPL native functions that deal with XML operations. More...

Functions
SPL::boolean	isDefaultValue (const SPL::xml &val)
SPL::boolean	convertToXML (SPL::xml &xmlResult, const std::string &str, SPL::int32 &error)
SPL::boolean	convertToXML (SPL::xml &xmlResult, const SPL::ustring &str, SPL::int32 &error)
SPL::boolean	convertToXML (SPL::xml &xmlResult, const SPL::BString &str, SPL::int32 &error)
SPL::boolean	convertToXML (SPL::xml &xmlResult, const std::string &str)
SPL::boolean	convertToXML (SPL::xml &xmlResult, const SPL::ustring &str)
SPL::boolean	convertToXML (SPL::xml &xmlResult, const SPL::BString &str)
SPL::list< SPL::rstring >	xquery (const SPL::xml &value, const SPL::rstring &xqueryExpression)
SPL::list< SPL::ustring >	xquery (const SPL::xml &value, const SPL::ustring &xqueryExpression)
SPL::list< SPL::rstring >	xquery (const SPL::xml &value, const SPL::rstring &xqueryExpression, const SPL::map< SPL::rstring, SPL::rstring > &xqueryVars)
SPL::list< SPL::ustring >	xquery (const SPL::xml &value, const SPL::ustring &xqueryExpression, const SPL::map< SPL::ustring, SPL::ustring > &xqueryVars)
SPL::list< SPL::rstring >	xquery (const SPL::xml &value, const SPL::rstring &xqueryExpression, SPL::int32 &error)
SPL::list< SPL::ustring >	xquery (const SPL::xml &value, const SPL::ustring &xqueryExpression, SPL::int32 &error)
SPL::list< SPL::rstring >	xquery (const SPL::xml &value, const SPL::rstring &xqueryExpression, const SPL::map< SPL::rstring, SPL::rstring > &xqueryVars, SPL::int32 &error)
SPL::list< SPL::ustring >	xquery (const SPL::xml &value, const SPL::ustring &xqueryExpression, const SPL::map< SPL::ustring, SPL::ustring > &xqueryVars, SPL::int32 &error)

Detailed Description

C++ counterparts of SPL native functions that deal with XML operations.

Function Documentation

SPL::boolean SPL::Functions::XML::isDefaultValue ( const SPL::xml &  val )

inline

Return if this XML value contains the default (uninitialized) value.

Parameters

val	Input XML value to be tests.

Returns

The value 'true' if the XML value is the default (uninitialized) value.

SPL::boolean SPL::Functions::XML::convertToXML	(	SPL::xml &	xmlResult,
		const std::string &	str,
		SPL::int32 &	error
	)

Convert a string to XML, returning the success status and an error code.

Parameters

xmlResult	Result XML value, if successful.
str	Input string.
error	Set to 0 on success, or error status if not successful.

Returns

The value 'true' if the conversion was successful, else 'false'.

SPL::boolean SPL::Functions::XML::convertToXML ( SPL::xml &  xmlResult, const SPL::ustring &  str, SPL::int32 &  error  )

inline

Convert a string to XML, returning the success status and an error code.

Parameters

xmlResult	Result XML value, if successful.
str	Input string.
error	Set to 0 on success, or error status if not successful.

Returns

The value 'true' if the conversion was successful, else 'false'.

SPL::boolean SPL::Functions::XML::convertToXML ( SPL::xml &  xmlResult, const SPL::BString &  str, SPL::int32 &  error  )

inline

Convert a string to XML, returning the success status and an error code.

Parameters

xmlResult	Result XML value, if successful.
str	Input string.
error	Set to 0 on success, or error status if not successful.

Returns

The value 'true' if the conversion was successful, else 'false'.

SPL::boolean SPL::Functions::XML::convertToXML	(	SPL::xml &	xmlResult,
		const std::string &	str
	)

Convert a string to XML, returning the success status.

Parameters

xmlResult	Result XML value, if successful.
str	Input string.

Returns

The value 'true' if the conversion was successful, else 'false'.

SPL::boolean SPL::Functions::XML::convertToXML ( SPL::xml &  xmlResult, const SPL::ustring &  str  )

inline

Convert a string to XML, returning the success status.

Parameters

xmlResult	Result XML value, if successful.
str	Input string.

Returns

The value 'true' if the conversion was successful, else 'false'.

SPL::boolean SPL::Functions::XML::convertToXML ( SPL::xml &  xmlResult, const SPL::BString &  str  )

inline

Convert a string to XML, returning the success status.

Parameters

xmlResult	Result XML value, if successful.
str	Input string.

Returns

The value 'true' if the conversion was successful, else 'false'.

SPL::list<SPL::rstring> SPL::Functions::XML::xquery	(	const SPL::xml &	value,
		const SPL::rstring &	xqueryExpression
	)

Execute an XQuery program against an XML value and return a list of results.

Starting with Streams v4.2.1.1, the xquery functions use the default namespace of the queried XML. If the xquery() function is given an xqueryExpression without a namespace declaration, then it returns an empty result if the queried document has an explicit namespace.

Parameters

value	XML value to be queried.
xqueryExpression	XQuery program to be executed.

Returns

List of string results from running the program against the XML value.

SPL::list<SPL::ustring> SPL::Functions::XML::xquery	(	const SPL::xml &	value,
		const SPL::ustring &	xqueryExpression
	)

Execute an XQuery program against an XML value and return a list of results.

Starting with Streams v4.2.1.1, the xquery functions use the default namespace of the queried XML. If the xquery() function is given an xqueryExpression without a namespace declaration, then it returns an empty result if the queried document has an explicit namespace.

Parameters

value	XML value to be queried.
xqueryExpression	XQuery program to be executed.

Returns

List of string results from running the program against the XML value.

SPL::list<SPL::rstring> SPL::Functions::XML::xquery	(	const SPL::xml &	value,
		const SPL::rstring &	xqueryExpression,
		const SPL::map< SPL::rstring, SPL::rstring > &	xqueryVars
	)

Execute an XQuery program against an XML value and return a list of results.

Starting with Streams v4.2.1.1, the xquery functions use the default namespace of the queried XML. If the xquery() function is given an xqueryExpression without a namespace declaration, then it returns an empty result if the queried document has an explicit namespace.

Parameters

value	XML value to be queried.
xqueryExpression	XQuery program to be executed.
xqueryVars	XQuery variable definitions.

Returns

List of string results from running the program against the XML value.

SPL::list<SPL::ustring> SPL::Functions::XML::xquery	(	const SPL::xml &	value,
		const SPL::ustring &	xqueryExpression,
		const SPL::map< SPL::ustring, SPL::ustring > &	xqueryVars
	)

Execute an XQuery program against an XML value and return a list of results.

Starting with Streams v4.2.1.1, the xquery functions use the default namespace of the queried XML. If the xquery() function is given an xqueryExpression without a namespace declaration, then it returns an empty result if the queried document has an explicit namespace.

Parameters

value	XML value to be queried.
xqueryExpression	XQuery program to be executed.
xqueryVars	XQuery variable definitions.

Returns

List of string results from running the program against the XML value.

SPL::list<SPL::rstring> SPL::Functions::XML::xquery	(	const SPL::xml &	value,
		const SPL::rstring &	xqueryExpression,
		SPL::int32 &	error
	)

Execute an XQuery program against an XML value and return a list of results.

Starting with Streams v4.2.1.1, the xquery functions use the default namespace of the queried XML. If the xquery() function is given an xqueryExpression without a namespace declaration, then it returns an empty result if the queried document has an explicit namespace.

Parameters

value	XML value to be queried.
xqueryExpression	XQuery program to be executed.
error	Set to 0 on success, or error status if not successful.

Returns

List of string results from running the program against the XML value.

SPL::list<SPL::ustring> SPL::Functions::XML::xquery	(	const SPL::xml &	value,
		const SPL::ustring &	xqueryExpression,
		SPL::int32 &	error
	)

Execute an XQuery program against an XML value and return a list of results.

Starting with Streams v4.2.1.1, the xquery functions use the default namespace of the queried XML. If the xquery() function is given an xqueryExpression without a namespace declaration, then it returns an empty result if the queried document has an explicit namespace.

Parameters

value	XML value to be queried.
xqueryExpression	XQuery program to be executed.
error	Set to 0 on success, or error status if not successful.

Returns

List of string results from running the program against the XML value.

SPL::list<SPL::rstring> SPL::Functions::XML::xquery	(	const SPL::xml &	value,
		const SPL::rstring &	xqueryExpression,
		const SPL::map< SPL::rstring, SPL::rstring > &	xqueryVars,
		SPL::int32 &	error
	)

Execute an XQuery program against an XML value and return a list of results.

Starting with Streams v4.2.1.1, the xquery functions use the default namespace of the queried XML. If the xquery() function is given an xqueryExpression without a namespace declaration, then it returns an empty result if the queried document has an explicit namespace.

Parameters

value	XML value to be queried.
xqueryExpression	XQuery program to be executed.
xqueryVars	XQuery variable definitions.
error	Set to 0 on success, or error status if not successful.

Returns

List of string results from running the program against the XML value.

SPL::list<SPL::ustring> SPL::Functions::XML::xquery	(	const SPL::xml &	value,
		const SPL::ustring &	xqueryExpression,
		const SPL::map< SPL::ustring, SPL::ustring > &	xqueryVars,
		SPL::int32 &	error
	)

Execute an XQuery program against an XML value and return a list of results.

Starting with Streams v4.2.1.1, the xquery functions use the default namespace of the queried XML. If the xquery() function is given an xqueryExpression without a namespace declaration, then it returns an empty result if the queried document has an explicit namespace.

Parameters

value	XML value to be queried.
xqueryExpression	XQuery program to be executed.
xqueryVars	XQuery variable definitions.
error	Set to 0 on success, or error status if not successful.

Returns

List of string results from running the program against the XML value.