dmi_decoder_stop

Synopsis

#include <opendmi/decoder.h>

bool dmi_decoder_stop(dmi_decoder_t *decoder);

Description

The dmi_decoder_stop function marks the structure with DMI_ENTITY_STATE_PARTIAL.

It is intended for the decoders of the structures which newer versions of the specification have extended, and is called once the data has been read to its end while the decoder knows of more fields.

The data is required to be exhausted. A structure which ends anywhere else is incomplete instead, see dmi_decoder_incomplete.

Parameters

decoder: Decoder of the structure.

Return value

true, so that it can be returned by the decoder, or false if decoder is nullptr.

Errors

None.