Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | Public Attributes | List of all members
Mezzanine::XML::XPathParseResult Struct Reference

XPath parsing result. More...

#include <xpathparseresult.h>

Public Member Functions

 XPathParseResult ()
 Default constructor, initializes object to failed state.
 
const char * Description () const
 Error message (0 if no error).
 
 operator bool () const
 Cast to bool operator. More...
 

Public Attributes

const char * error
 Error message (0 if no error) More...
 
ptrdiff_t Offset
 Last parsed Offset (in Character units from string start)
 

Detailed Description

XPath parsing result.

Definition at line 73 of file xpathparseresult.h.

Member Function Documentation

Mezzanine::XML::XPathParseResult::operator bool ( ) const

Cast to bool operator.

Returns
This returns true if the ParseResult::Status member is set to ParseStatus::StatusOk, otherwise this returns false.
Note
Not usable from scripting languages.

Member Data Documentation

const char* Mezzanine::XML::XPathParseResult::error

Error message (0 if no error)

Note
For compatibility reasons this is not available in scripting languages (const string can lead to memory leak and undefiend behavior.)

Definition at line 78 of file xpathparseresult.h.


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