BloombergLP::balxml::Decoder::decode

Synopsis

Declared in <balxml_decoder.h>

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

Description

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.

Return Value

0 on success, and a non-zero value otherwise

Parameters

Name	Description
buffer	buffer providing XML data
object	object being decoded
uri	optional URI identifying the input document in error messages