Back to Aurora Vision Library Lite website
You are here: Start » All Functions » Xml » Xml_SelectSingleNodeValue_AsBool
Xml_SelectSingleNodeValue_AsBool
This is Filter Equivalent. This function may be present in generated code, but should not be used in hand-written code.
Header: | STD.h |
---|---|
Namespace: | avl |
Selects node from the XML tree using XPath request.
Syntax
void avl::Xml_SelectSingleNodeValue_AsBool ( const avl::XmlNode& inNode, const atl::String& inXPath, const atl::Optional<bool>& inDefault, atl::Conditional<avl::XmlNode>& outNode, bool& outNodeValue )
Parameters
Name | Type | Default | Description | |
---|---|---|---|---|
inNode | const XmlNode& | Source node. | ||
inXPath | const String& | XPath criteria. | ||
inDefault | const Optional<bool>& | NIL | If no node was found default value will be used. | |
outNode | Conditional<XmlNode>& | Found node. | ||
outNodeValue | bool& | Found node text as Boolean. |
Description
Filter finds node using provided XPath query. Found node's value is converted to Bool type. Filter checks only first character of selected node's value. Characters Y, y, T, t, 1 will be parsed as True value. Value False will be returned if one of characters N, n, F, f, 0 will be found. If other character is found default value is returned.
If no node is found exception is thrown.
See Also
- Xml_SelectSingleNode – Selects a node from the XML tree using an XPath request.
- Xml_SelectMultipleNodes – Selects nodes from the XML tree using XPath request.