BloombergLP::balxml::Decoder::decode

Decode object from the specified input stream.

Synopsis

Declared in <balxml_decoder.h>

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

Description

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.

Return Value

a reference to the modifiable stream

Parameters

Name

Description

stream

input stream providing XML data

object

object being decoded

uri

optional URI identifying the input document in error messages

Created with MrDocs