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

silc_buffer_format

SYNOPSIS

    int silc_buffer_format(SilcBuffer dst, ...);

DESCRIPTION

Formats a buffer from a variable argument list. Returns -1 if the system is out of memory and the length of the formatted buffer otherwise. The buffer is enlarged automatically during formatting, if it doesn't already have enough space. Sets silc_errno in case of error.

EXAMPLE

    Three basic ways of using silc_buffer_format:

    // Statically allocated zero size buffer
    SilcBufferStruct buffer;

    memset(&buffer, 0, sizeof(buffer));
    ret = silc_buffer_format(&buffer,
                             SILC_STR_UINT32(intval),
                             SILC_STR_UINT8(charval),
                             SILC_STR_UINT32(intval),
                             SILC_STR_UINT16(str_len),
                             SILC_STR_DATA(str, str_len),
                             SILC_STR_END);
    if (ret < 0)
      error;

    // Free the allocated data
    silc_buffer_purge(&buffer);

    // Dynamically allocated zero size buffer
    SilcBuffer buf;
    buf = silc_buffer_alloc(0);
    ret = silc_buffer_format(buf,
                             SILC_STR_UINT32(intval),
                             SILC_STR_UINT8(charval),
                             SILC_STR_END);
    if (ret < 0)
      error;

    // Free the allocated buffer
    silc_buffer_free(buf);

    // Dynamically allocated buffer with enough space
    SilcBuffer buf;
    buf = silc_buffer_alloc(2 + str_len);
    ret = silc_buffer_format(buf,
                             SILC_STR_UINT16(str_len),
                             SILC_STR_DATA(str, str_len),
                             SILC_STR_END);
    if (ret < 0)
      error;