BloombergLP::balxml::Decoder::decode

Synopses

Declared in <balxml_decoder.h>

Decode the specified object of parameterized TYPE from the input source specified by a previous call to open and leave the reader in an open state. Return 0 on success, and a non-zero value otherwise. A compilation error will result unless TYPE conforms to the requirements of a bdlat sequence or choice, as described in bdlat_sequencefunctions and bdlat_choicefunctions. The behavior is undefined unless this call was preceded by a prior successful call to open

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

» more...

Decode the specified object of parameterized TYPE from the file with the specified filename. Return 0 on success, and a non-zero value otherwise. A compilation error will result unless TYPE conforms to the requirements of a bdlat sequence or choice, as described in bdlat_sequencefunctions and bdlat_choicefunctions.

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

» more...

Decode the specified object of parameterized TYPE from the specified input stream. Return a reference to the modifiable stream. If a decoding error is detected, stream.fail() will be true after this method returns. The (optionally) specified uri is used for identifying the input document in error messages. A compilation error will result unless TYPE conforms to the requirements of a bdlat sequence or choice, as described in bdlat_sequencefunctions and bdlat_choicefunctions.

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

» more...

Decode the specified object of parameterized TYPE from the specified stream buffer. The (optionally) specified uri is used for identifying the input document in error messages. Return 0 on success, and a non-zero value otherwise. A compilation error will result unless TYPE conforms to the requirements of a bdlat sequence or choice, as described in bdlat_sequencefunctions and bdlat_choicefunctions.

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

» more...

Decode the specified object of parameterized TYPE from the memory at the specified buffer address, having the specified length. The (optionally) specified uri is used for identifying the input document in error messages. Return 0 on success, and a non-zero value otherwise. A compilation error will result unless TYPE conforms to the requirements of a bdlat sequence or choice, as described in bdlat_sequencefunctions and bdlat_choicefunctions.

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

» more...