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

SilcBufferFormatFunc

SYNOPSIS

    typedef int (*SilcBuffeSFormatFunc)(SilcStack stack,
                                        SilcBuffer buffer,
                                        void *value,
                                        void *context);

DESCRIPTION

Formatting function callback given with SILC_STR_FUNC type. The `buffer' is the buffer being formatted at the location where the SILC_STR_FUNC was placed in formatting. The function should call silc_buffer_senlarge before it adds the data to the buffer to make sure that it has enough space. The buffer->head points to the start of the buffer and silc_buffer_headlen() gives the length of the currently formatted data area. It is also possible to use silc_buffer_sformat with `buffer' which will enlarge the buffer if needed.

The `value' is the value given to SILC_STR_FUNC that is to be formatted into the buffer. It may be NULL if the function is not formatting new data into the buffer. The `context' is caller specific context. Returns -1 on error and length of the formatted value otherwise, and 0 if nothing was formatted.