Buffer Format Interface SilcBufferFormatFunc SilcBufferUnformatFunc silc_buffer_format silc_buffer_sformat silc_buffer_format_vp silc_buffer_sformat_vp silc_buffer_unformat silc_buffer_sunformat silc_buffer_unformat_vp silc_buffer_sunformat_vp silc_buffer_strformat silc_buffer_sstrformat SILC_STR_SINT8 SILC_STR_UINT8 SILC_STR_SINT16 SILC_STR_UINT16 SILC_STR_SINT32 SILC_STR_UINT32 SILC_STR_SINT64 SILC_STR_UINT64 SILC_STR_STRING SILC_STR_*_STRING SILC_STR_*_NSTRING SILC_STR_DATA SILC_STR_BUFFER SILC_STR_REPLACE SILC_STR_FUNC SilcBufferRegexFlags SILC_STR_REGEX SILC_STR_DELETE SILC_STR_OFFSET SILC_STR_OFFSET_START SILC_STR_OFFSET_END SILC_STR_ADVANCE SILC_STR_END SILC_STRFMT_END

SilcBufferUnformatFunc

SYNOPSIS

    typedef int (*SilcBufferUnformatFunc)(SilcBuffer buffer,
                                          void **value,
                                          void *context);

DESCRIPTION

Unformatting function callback given with SILC_STR_FUNC type. The `buffer' is the buffer being unformatted and is at the location where the SILC_STR_FUNC was placed in unformatting. The function should check there is enough data in the `buffer' before trying to decode from it.

If this function unformats anything from the buffer its value is to be returned to the `value' pointer. The implementation should itself decide whether the unformatted value is allocated or not. If this function does not unformat anything, nothing is returned to `value'

The `context' is caller specific context. Returns -1 on error, and length of the unformatted value otherwise, and 0 if nothing was unformatted.