decode overloads

Synopses

Declared in <balxml_decoder.h>

Decode object from the previously opened input source.

template<class TYPE>
int
decode(TYPE* object);

Decode object from the file with the specified filename.

template<class TYPE>
int
decode(
    char const* filename,
    TYPE* object);

Decode object from the specified input stream.

template<class TYPE>
std::istream&
decode(
    std::istream& stream,
    TYPE* object,
    char const* uri = 0);

Decode object from the specified stream buffer.

template<class TYPE>
int
decode(
    std::streambuf* buffer,
    TYPE* object,
    char const* uri = 0);

Decode object from the specified memory buffer.

template<class TYPE>
int
decode(
    char const* buffer,
    std::size_t length,
    TYPE* object,
    char const* uri = 0);

Return Value

  • 0 on success, and a non‐zero value otherwise

  • a reference to the modifiable stream

Parameters

Name

Description

object

object being decoded

filename

path of the XML file to open

stream

input stream providing XML data

uri

optional URI identifying the input document in error messages

buffer

buffer providing XML data

length

number of bytes in buffer

Created with MrDocs