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

Troubleshooting data intended to help troublshoot XML parsing errors. More...

#include <parseresult.h>

Public Member Functions

 ParseResult ()
 Default constructor, initializes object to failed state.
 
const char * Description () const
 Get error Description. More...
 
 operator bool () const
 Cast to bool operator. More...
 

Public Attributes

Encoding DocumentEncoding
 Source document encoding ( see Encoding )
 
ptrdiff_t Offset
 Last parsed offset (in char_t units from start of input data)
 
ParseStatus Status
 Parsing status ( see ParseStatus )
 

Detailed Description

Troubleshooting data intended to help troublshoot XML parsing errors.

Definition at line 71 of file parseresult.h.

Member Function Documentation

const char* Mezzanine::XML::ParseResult::Description ( ) const

Get error Description.

Returns
A c-syle string that contains the
Mezzanine::XML::ParseResult::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.

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