dmi_encoder_finish

Synopsis

#include <opendmi/encoder.h>

bool dmi_encoder_finish(dmi_encoder_t *encoder);

Description

The dmi_encoder_finish function completes the formatted area by filling in the length of the header, which is known once every field has been written.

Parameters

encoder

Encoder to complete.

Return value

true on success, false otherwise.

Errors

DMI_ERROR_STATE_INVALID

Writer of the encoder has been moved back over the header, so that there is no formatted area to complete.

DMI_ERROR_ENTITY_LENGTH_INVALID

Formatted area is longer than a byte can count.