lbmsdm.h

Go to the documentation of this file.

/** \file lbmsdm.h
        \brief Ultra Messaging (UM) Self-Describing Message (SDM) API
        \author David K. Ameiss - Informatica Corporation 
        \version $Id: //UMprod/REL_5_3_6/29West/lbm/src/sdm/lbm/lbmsdm.h#2 $

        The Ultra Messaging (UM) Self-Describing Message (SDM)
        API Description. Included are types, constants, and functions related
        to the API. Contents are subject to change.

        All of the documentation and software included in this and any
        other Informatica Corporation Ultra Messaging Releases
        Copyright (C) Informatica Corporation. All rights reserved.

        Redistribution and use in source and binary forms, with or without
        modification, are permitted only as covered by the terms of a
        valid software license agreement with Informatica Corporation.

        Copyright (C) 2007-2014, Informatica Corporation. All Rights Reserved.

        THE SOFTWARE IS PROVIDED "AS IS" AND INFORMATICA DISCLAIMS ALL WARRANTIES
        EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF
        NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
        PURPOSE.  INFORMATICA DOES NOT WARRANT THAT USE OF THE SOFTWARE WILL BE
        UNINTERRUPTED OR ERROR-FREE.  INFORMATICA SHALL NOT, UNDER ANY CIRCUMSTANCES, BE
        LIABLE TO LICENSEE FOR LOST PROFITS, CONSEQUENTIAL, INCIDENTAL, SPECIAL OR
        INDIRECT DAMAGES ARISING OUT OF OR RELATED TO THIS AGREEMENT OR THE
        TRANSACTIONS CONTEMPLATED HEREUNDER, EVEN IF INFORMATICA HAS BEEN APPRISED OF
        THE LIKELIHOOD OF SUCH DAMAGES.

        The LBM Self-Describing Message (SDM) API provides a framework for applications
        to create and use messages containing self-describing data (name and type).
        An SDM message contains one or more \b fields. Each field consists of:
        - A name, limited to 255 characters in length. Field names are \em not case-sensitive.
          So, "price" is the same as "Price" is the same as "PRICE".
        - A type (discussed below).
        - A value (particular to the field type).
        Each named field may only appear once in a message. If multiple fields of the same name
        and type are needed, create an array field. A field in a nested message \b may have the
        same name as a field in the outer message, though.

        \par Field types
        The following field types (and arrays thereof) are supported by SDM:
        <table>
                <tr>
                        <td>Description</td>
                        <td>SDM Type</td>
                        <td>C Type</td>
                </tr>
                <tr>
                        <td>Boolean</td>
                        <td>::LBMSDM_TYPE_BOOLEAN</td>
                        <td><tt>uint8_t</tt></td>
                </tr>
                <tr>
                        <td>8-bit signed integer</td>
                        <td>::LBMSDM_TYPE_INT8</td>
                        <td><tt>int8_t</tt></td>
                </tr>
                <tr>
                        <td>8-bit unsigned integer</td>
                        <td>::LBMSDM_TYPE_UINT8</td>
                        <td><tt>uint8_t</tt></td>
                </tr>
                <tr>
                        <td>16-bit signed integer</td>
                        <td>::LBMSDM_TYPE_INT16</td>
                        <td><tt>int16_t</tt></td>
                </tr>
                <tr>
                        <td>16-bit unsigned integer</td>
                        <td>::LBMSDM_TYPE_UINT16</td>
                        <td><tt>uint16_t</tt></td>
                </tr>
                <tr>
                        <td>32-bit signed integer</td>
                        <td>::LBMSDM_TYPE_INT32</td>
                        <td><tt>int32_t</tt></td>
                </tr>
                <tr>
                        <td>32-bit unsigned integer</td>
                        <td>::LBMSDM_TYPE_UINT32</td>
                        <td><tt>uint32_t</tt></td>
                </tr>
                <tr>
                        <td>64-bit signed integer</td>
                        <td>::LBMSDM_TYPE_INT64</td>
                        <td><tt>int64_t</tt></td>
                </tr>
                <tr>
                        <td>64-bit unsigned integer</td>
                        <td>::LBMSDM_TYPE_UINT64</td>
                        <td><tt>uint64_t</tt></td>
                </tr>
                <tr>
                        <td>Single-precision floating point</td>
                        <td>::LBMSDM_TYPE_FLOAT</td>
                        <td><tt>float</tt></td>
                </tr>
                <tr>
                        <td>Double-precision floating point</td>
                        <td>::LBMSDM_TYPE_DOUBLE</td>
                        <td><tt>double</tt></td>
                </tr>
                <tr>
                        <td>String</td>
                        <td>::LBMSDM_TYPE_STRING</td>
                        <td><tt>char *</tt></td>
                </tr>
                <tr>
                        <td>Scaled decimal</td>
                        <td>::LBMSDM_TYPE_DECIMAL</td>
                        <td>::lbmsdm_decimal_t</td>
                </tr>
                <tr>
                        <td>Timestamp</td>
                        <td>::LBMSDM_TYPE_TIMESTAMP</td>
                        <td><tt>struct timeval</tt></td>
                </tr>
                <tr>
                        <td>Nested message</td>
                        <td>::LBMSDM_TYPE_MESSAGE</td>
                        <td>::lbmsdm_msg_t <tt>*</tt></td>
                </tr>
                <tr>
                        <td>Binary large object (BLOB)</td>
                        <td>::LBMSDM_TYPE_BLOB</td>
                        <td><tt>void *</tt></td>
                </tr>
                <tr>
                        <td>Unicode string</td>
                        <td>::LBMSDM_TYPE_UNICODE</td>
                        <td><tt>wchar_t *</tt></td>
                </tr>
        </table>
        \par
        Note that arrays are homogeneous.
        All elements of an array must be of the same type.
        An error is reported if an attempt is made to add an element of one type to
        an array containing elements of a different type.
        \par Building a message
        A message must be created (via ::lbmsdm_msg_create() or ::lbmsdm_msg_parse())
        before fields can be added.
        \par
        Once a field exists within a message,
        it can be referenced in one of three ways:
        - By the name associated with the field.
        - By index. This refers to the sequential position of the field within a message.
          The first field has index 0, the second has index 1, and so forth.
        - By iterator. See below for more information on iterators.
        \par Adding fields to a message
        Scalar (non-array) fields are added to a message via the <tt>lbmsdm_msg_add_xxx()</tt>
        API functions,
        where <tt>xxx</tt> is the type of the field being added.
        See the module \ref add for information on these functions.
        \par
        When adding a field, data of the appropriate type must be supplied.
        As an example, to add a 32-bit signed integer field named "quantity" to a message:
        \code
int32_t quant = 50;
int rc;
rc = lbmsdm_msg_add_int32(msg, "quantity", quant);
        \endcode
        \par
        Alternatively,
        literals may be used to specify the value.
        The above example could also be coded as:
        \code
rc = lbmsdm_msg_add_int32(msg, "quantity", 50);
        \endcode
        \par Adding array fields to a message
        Array fields are added to a message in two steps.
        First, the field itself is added via the <tt>lbmsdm_msg_add_xxx_array()</tt> API functions,
        where <tt>xxx</tt> is the type of the field being added.
        This does not provide a value for the field.
        See the module \ref add_array for information on these functions.
        \par
        Second,
        individual elements are added to the array field.
        This is done via the <tt>lbmsdm_msg_add_xxx_elem_idx()</tt>,
        <tt>lbmsdm_msg_add_xxx_elem_name()</tt>,
        and <tt>lbmsdm_iter_add_xxx_elem()</tt> API functions.
        See the modules \ref add_elem_idx, \ref add_elem_name, and \ref add_elem_iter
        for detailed information on these functions.
        \par
        As an example,
        the following code illustrates how to create a string array field,
        and add 3 elements to it.
        \code
rc = lbmsdm_msg_add_string_array(msg, "string_array");
rc = lbmsdm_msg_add_string_elem_name(msg, "string_array", "String1");
rc = lbmsdm_msg_add_string_elem_name(msg, "string_array", "String2");
rc = lbmsdm_msg_add_string_elem_name(msg, "string_array", "String3");
        \endcode
        \par Serializing the message
        Once the SDM message is constructed, it must be serialized for transmission.
        The API function ::lbmsdm_msg_get_data() returns a static pointer to a buffer
        containing the serialized form of the message, suitable for transmission.
        The length of the serialized data may be obtained via the API function
        ::lbmsdm_msg_get_datalen().
        For example, a constructed message may be sent by:
        \code
rc = lbm_src_send(src, lbmsdm_msg_get_data(msg), lbmsdm_msg_get_length(msg), 0);
        \endcode
        \par
        The pointer returned by ::lbmsdm_msg_get_data() is owned by the SDM API,
        and will automatically be freed when the message is destroyed.
        \par Deserializing a message
        When a message is received, it must be deserialized so that individual fields can be
        accessed. This is done via the ::lbmsdm_msg_parse() API function:
        \code
lbmsdm_msg_t * sdmmsg;
rc = lbmsdm_msg_parse(&sdmmsg, lbmmsg->data, lbmmsg->len);
        \endcode
        \par Disposing of a message
        Once an SDM message (created by either the ::lbmsdm_msg_create() or ::lbmsdm_msg_parse()
        API calls) is no longer needed, it must be disposed of to avoid a resource leak.
        This is done via the ::lbmsdm_msg_destroy() API call.
        \par Retrieving field information
        A number of API functions are available to retrieve information about individual fields.
        - ::lbmsdm_msg_get_fldcnt() returns the number of fields in the message.
        - ::lbmsdm_msg_get_name_idx() and ::lbmsdm_iter_get_name() return the field name
          associated with the referenced field.
        - ::lbmsdm_msg_get_type_name(), ::lbmsdm_msg_get_type_idx(), and
          ::lbmsdm_iter_get_type() return the type of the referenced field.
        - ::lbmsdm_msg_get_elemcnt_name(), ::lbmsdm_msg_get_elemcnt_idx(),
          and ::lbmsdm_iter_get_elemcnt() return the number of elements in an
          array field.
        - ::lbmsdm_msg_get_len_name(), ::lbmsdm_msg_get_len_idx(), and
          ::lbmsdm_iter_get_len() return the length (in bytes) required for a field.
        - ::lbmsdm_msg_get_elemlen_name(), ::lbmsdm_msg_get_elemlen_idx(),
          and ::lbmsdm_iter_get_elemlen() return the length (in bytes) for a specific
          element in an array field.
        \par Fetching fields from a message
        When fetching a field from a message, the field may be referenced by name, by index,
        or via an iterator.
        \par
        Scalar (non-array) fields may be retrieved via the <tt>lbmsdm_msg_get_xxx_name()</tt>,
        <tt>lbmsdm_msg_get_xxx_idx()</tt>, or <tt>lbmsdm_iter_get_xxx()</tt> functions,
        where <tt>xxx</tt> is the type the field value should be retrieved as.
        The sections \ref get_scalar_name, \ref get_scalar_idx, and \ref get_scalar_iter contain
        detailed information on these functions.
        \par
        Array field elements may be retrieved via the <tt>lbmsdm_msg_get_xxx_elem_name()</tt>,
        <tt>lbmsdm_msg_get_xxx_elem_idx()</tt>, or <tt>lbmsdm_iter_get_xxx_elem()</tt> functions,
        where <tt>xxx</tt> is the type the field element value should be retrieved as.
        The sections \ref get_elem_name, \ref get_elem_idx, and \ref get_elem_iter contain
        detailed information on these functions.
        \par Type conversion
        A limited form of automatic type conversion is provided.
        For example, given a field defined as ::LBMSDM_TYPE_UINT16, its value may be retrieved
        as an ::LBMSDM_TYPE_UINT32.
        The following table details which type conversions are supported.
        <table>
                <tr>
                        <td colspan=2 rowspan=2></td>
                        <th colspan=17 align=center>To</th>
                </tr>
                <tr>
                        <th>boolean</th>
                        <th>int8</th>
                        <th>uint8</th>
                        <th>int16</th>
                        <th>uint16</th>
                        <th>int32</th>
                        <th>uint32</th>
                        <th>int64</th>
                        <th>uint64</th>
                        <th>float</th>
                        <th>double</th>
                        <th>string</th>
                        <th>unicode</th>
                        <th>timestamp</th>
                        <th>BLOB</th>
                        <th>message</th>
                        <th>decimal</th>
                </tr>
                <tr align=center>
                        <th rowspan=17>From</th>
                        <th>boolean</th>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>Yes</td>
                </tr>
                <tr>
                        <th>int8</th>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>Yes</td>
                </tr>
                <tr>
                        <th>uint8</th>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>Yes</td>
                </tr>
                <tr>
                        <th>int16</th>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>Yes</td>
                </tr>
                <tr>
                        <th>uint16</th>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>Yes</td>
                </tr>
                <tr>
                        <th>int32</th>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>Yes</td>
                </tr>
                <tr>
                        <th>uint32</th>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>Yes</td>
                </tr>
                <tr>
                        <th>int64</th>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>Yes</td>
                </tr>
                <tr>
                        <th>uint64</th>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>Yes</td>
                </tr>
                <tr>
                        <th>float</th>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                </tr>
                <tr>
                        <th>double</th>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                </tr>
                <tr>
                        <th>string</th>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>Yes</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                </tr>
                <tr>
                        <th>unicode</th>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>Yes</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                </tr>
                <tr>
                        <th>timestamp</th>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>Yes</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                </tr>
                <tr>
                        <th>BLOB</th>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>Yes</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                </tr>
                <tr>
                        <th>message</th>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>Yes</td>
                        <td align=center>No</td>
                </tr>
                <tr>
                        <th>decimal</th>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>Yes</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>No</td>
                        <td align=center>Yes</td>
                </tr>
        </table>
        \par
        The above conversion rules apply also when retrieving array elements.
        \par Fetching string, unicode, and BLOB values
        When fetching a field or array element value as a string, unicode, or BLOB,
        the data is copied into a buffer provided by the application.
        In addition to the buffer,
        the size of the buffer must be given.
        The size is specified in bytes for string and BLOB fields,
        and in <tt>wchar_t</tt>s for unicode fields.
        If the size specified is too small for the data,
        the error code ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH is returned.
        \par
        \par Fetching message fields
        When fetching the value of a message field,
        a copy of the message is created (via ::lbmsdm_msg_clone()) and returned.
        It is the application's responsibility to destroy the message (via ::lbmsdm_msg_destroy())
        when it is no longer needed.
        \par Modifying fields in a message
        Existing fields in a message may be modified, both in terms of the field type and
        field value.
        For scalar (non-array) fields,
        the <tt>lbmsdm_msg_set_xxx_idx()</tt>, <tt>lbmsdm_msg_set_xxx_name()</tt>,
        and <tt>lbmsdm_iter_set_xxx()</tt> API functions may be used,
        where <tt>xxx</tt> is the type to be assigned to the field.
        See the sections \ref set_idx, \ref set_name, and \ref set_iter for information
        on these functions.
        \par
        For array fields,
        the <tt>lbmsdm_msg_set_xxx_array_idx()</tt>, <tt>lbmsdm_msg_set_xxx_array_name()</tt>,
        and <tt>lbmsdm_iter_set_xxx_array()</tt> API functions may be used,
        where <tt>xxx</tt> is the type to be assigned to the field.
        See the sections \ref set_array_idx, \ref set_array_name, and \ref set_array_iter
        for information on these functions.
        As when adding an array field to a message,
        once the field type has been set to an array type,
        individual elements must be added to the array field.
        \par
        Individual elements of an array field may be modified via the <tt>lbmsdm_msg_set_xxx_elem_idx()</tt>,
        <tt>lbmsdm_msg_set_xxx_elem_name()</tt>, and <tt>lbmsdm_iter_set_xxx_elem()</tt> API functions.
        See the sections \ref set_elem_idx, \ref set_elem_name, and \ref set_elem_iter for
        information on these functions.
        Note that arrays must contain homogeneous elements,
        so the type of an array element may not be changed,
        and is considered an error.
        \par Deleting fields from a message
        A field may be deleted from a message via the ::lbmsdm_msg_del_idx(),
        ::lbmsdm_msg_del_name(), and ::lbmsdm_iter_del() API calls.
        Deleting a field will cause any fields following it to be moved down one position,
        changing the index of those fields and potentially invalidating any iterators for
        that message.
        \par Deleting elements from an array field
        Individual elements may be deleted from an array field via the ::lbmsdm_msg_del_elem_idx(),
        ::lbmsdm_msg_del_elem_name(), and ::lbmsdm_iter_del_elem() API functions.
        \par Null fields
        SDM supports the concept of a \b null field.
        A null field is present in the message,
        but has no value associated with it.
        Once added to a message,
        a field may be set to null via the ::lbmsdm_msg_set_null_idx(), ::lbmsdm_msg_set_null_name(),
        or ::lbmsdm_iter_set_null() API functions.
        Setting the field (which may be either a scalar or array field) to null
        removes any values currently associated with the field.
        \par
        The ::lbmsdm_msg_is_null_idx(), ::lbmsdm_msg_is_null_name(), and ::lbmsdm_iter_is_null()
        API functions allow an application to determine if a given field is null.
        \par
        Attempting to retrieve a value or element value from a null field is not allowed,
        and will return an error.
        \par Iterators
        A field iterator allows sequential operation on the fields of a message without requiring
        the field name or index.
        An iterator is created via ::lbmsdm_iter_create(),
        the first field in a message is located via ::lbmsdm_iter_first(),
        and the next field is located via ::lbmsdm_iter_next().
        An iterator should be destroyed when no longer needed, using the ::lbmsdm_iter_destroy()
        API call.
        \par
        Message fields may be queried, fetched, modified, and deleted via an iterator.
        In each case,
        the operation applies to the field currently referenced by the iterator.
        \par Error information
        All functions return a value to indicate the success of failure of the operation.
        Most return ::LBMSDM_SUCCESS to indicate success, or ::LBMSDM_FAILURE otherwise.
        Consult the individual function documentation for exceptions.
        \par
        The function ::lbmsdm_errnum() can be used to retrieve a detailed error code for the last
        error encountered, while ::lbmsdm_errmsg() will return a descriptive error message.
        \par Message Options
        The performance of SDM can be tuned through the use of message options.
        Options are contained within an attributes object (::lbmsdm_msg_attr_t),
        which is created via ::lbmsdm_msg_attr_create().
        When no longer needed,
        an attributes object can be discarded by calling ::lbmsdm_msg_attr_delete().
        Individual options within an attributes object can be set via ::lbmsdm_msg_attr_setopt()
        and ::lbmsdm_msg_attr_str_setopt(),
        and can be queried via ::lbmsdm_msg_attr_getopt() and ::lbmsdm_msg_attr_str_getopt().
        A set of options can be specified at message creation time using ::lbmsdm_msg_create_ex()
        and ::lbmsdm_msg_parse_ex().
        \par
        The following table lists the supported message options.
        <table>
                <tr>
                        <th>Option</th>
                        <th>Data type</th>
                        <th>Allowed values</th>
                        <th>Default</th>
                        <th>Description</th>
                </tr>
                <tr>
                        <th align="left"><tt>field_array_allocation</tt></th>
                        <td align="center"><tt>int</tt></td>
                        <td align="center">Any integer >= 0</td>
                        <td align="center">32</td>
                        <td>
                                Internally, SDM maintains an array of field entries within a message.
                                This option controls both the number of field entries initially allocated
                                when the message is created,
                                and the increment used when the array must be expanded when a field is added
                                but the array is full.
                                <p>
                                If it is known that a large number of fields will be added to a message,
                                setting this option to a larger value will result in a slight performance
                                boost,
                                since reallocation of the field array will occur less frequently.
                                </p>
                                <p>
                                Similarly,
                                if the number of fields to be added is small,
                                setting this option to a smaller value will effect a small savings in memory
                                usage (as well as reducing memory fragmentation).
                                </p>
                        </td>
                </tr>
                <tr>
                        <th align="left"><tt>name_tree</tt></th>
                        <td align="center"><tt>int</tt></td>
                        <td align="center">1 (enable) or 0 (disable)</td>
                        <td align="center">1</td>
                        <td>
                                In order to speed up access to fields by name,
                                a tree of field names is maintained for each message.
                                Maintenance of this tree
                                (such as when fields are added or deleted)
                                does incur some overhead.
                                <p>
                                In situations where fields are only added to a message
                                (and not retrieved),
                                this overhead can be eliminated by setting this option to <TT>0</TT>.
                                Be aware,
                                however,
                                that retrieving a field by name from a message for which the name
                                tree is disabled,
                                will degenerate to using a linear search of the field array to
                                locate the named field.
                                This can incur much more overhead than was saved by not using
                                the name tree.
                                </p>
                                <p>
                                In addition,
                                the use of the name tree allows SDM to detect
                                (and prevent)
                                the attempt to add two fields with the same name.
                                Disabling the name tree also disables this safeguard.
                                Further,
                                any attempts to parse a message with duplicate field names using
                                ::lbmsdm_msg_parse() or ::lbmsdm_msg_parse_ex() will fail
                                and return an error.
                                </p>
                        </td>
                </tr>
                <tr>
                        <th align="left"><tt>integer_index</tt></th>
                        <td align="center"><tt>int</tt></td>
                        <td align="center">1 (enable) or 0 (disable)</td>
                        <td align="center">0</td>
                        <td>
                                Some optimizations can be done within SDM if it is known that each field
                                name will be the string representation of a non-negative integer.
                                Rather than looking up by name,
                                each field name is used as the index of the field,
                                and name lookups can be faster.
                                <p>
                                This option requires each field name to be a string representation of a
                                non-negative integer.
                                Any attempts to add a field or parse a message containing a field name which
                                is not the string representation of a non-negative integer,
                                when this option is set,
                                will fail and return an error.
                                </p>
                        </td>
                </tr>
        </table>
        \par
        As an example,
        the following code fragment creates an attributes object,
        sets options,
        get the options,
        creates a message using the attributes object,
        then destroys the attributes object.
        For the sake of brevity,
        error checking has been omitted,
        as has the code to add fields to the message.
        \code
lbmsdm_msg_attr_t * attr;
lbmsdm_msg_t * msg;
int name_tree;
int alloc_size;
char val_buf[256];
size_t val_len;

lbmsdm_msg_attr_create(&attr);

name_tree = 0;
lbmsdm_msg_attr_setopt(attr, "name_tree", (void *)&name_tree, sizeof(name_tree));
lbmsdm_msg_attr_str_setopt(attr, "field_array_allocation", "128");

val_len = sizeof(val_buf);
lbmsdm_msg_attr_str_getopt(attr, "name_tree", val_buf, &val_len);
printf("name_tree=%s\n", val_buf);
val_len = sizeof(alloc_size);
lbmsdm_msg_attr_getopt(attr, "field_array_allocation", (void *)&alloc_size, &val_len);
printf("field_array_allocation=%d\n", alloc_size);

lbmsdm_msg_create_ex(&msg, attr);

lbmsdm_msg_attr_delete(attr);
        \endcode
*/

#if !defined(LBMSDM_H_INCLUDED)
#define LBMSDM_H_INCLUDED

#if defined(__cplusplus)
extern "C" {
#endif

#include <stdlib.h>
#if defined(_WIN32)
        #include <windows.h>
        #include <winsock2.h>
#if !defined(DONT_TYPEDEF_INT_T)
  typedef __int8 int8_t;
  typedef __int16 int16_t;
  typedef __int32 int32_t;
  typedef __int64 int64_t;
#endif
  typedef unsigned __int8 uint8_t;
  typedef unsigned __int16 uint16_t;
  typedef unsigned __int32 uint32_t;
  typedef unsigned __int64 uint64_t;

        /* C99 printf format macros missing from VC. */
        #define PRId8 "d"
        #define PRId16 "d"
        #define PRId32 "d"
        #define PRId64 "I64d"
        #define PRIu8 "u"
        #define PRIu16 "u"
        #define PRIu32 "u"
        #define PRIu64 "I64u"
#elif defined(__VMS)
        #include <inttypes.h>
        #define PRId8 "d"
        #define PRId16 "d"
        #define PRId32 "d"
        #define PRId64 "lld"
        #define PRIu8 "u"
        #define PRIu16 "u"
        #define PRIu32 "u"
        #define PRIu64 "llu"
#else
        #include <inttypes.h>
        #include <sys/time.h>
#endif

/* Directives to show how we treat exporting functions with Windows from the DLL */
#if defined(_WIN32)
        #if defined(_DLL) && defined(LBM_EXPORT_SYMS)
                #define LBMSDMExpDLL __declspec(dllexport)
        #elif defined(LBM_STATIC_LIB)
                #define LBMSDMExpDLL
        #else
                #define LBMSDMExpDLL __declspec(dllimport)
        #endif
#elif defined(__TANDEM)
        #if defined(LBM_EXPORT_SYMS)
                #define LBMSDMExpDLL export$
        #else
                #define LBMSDMExpDLL import$
        #endif
#else
        #define LBMSDMExpDLL
#endif

/*!     \brief Maximum length of a field name.
*/
#define LBMSDM_MAX_FIELD_NAME_LENGTH 255

struct lbmsdm_msg_attr_t_stct;
/*!     \brief Message attributes object for SDM (opaque).
*/
typedef struct lbmsdm_msg_attr_t_stct lbmsdm_msg_attr_t;

struct lbmsdm_msg_t_stct;
/*!     \brief Message object for SDM (opaque).
*/
typedef struct lbmsdm_msg_t_stct lbmsdm_msg_t;

/*!     \brief Type definition for an SDM field type.
*/
typedef uint16_t lbmsdm_field_type_t;

struct lbmsdm_iter_t_stct;
/*!     \brief Message iterator object for SDM (opaque).
*/
typedef struct lbmsdm_iter_t_stct lbmsdm_iter_t;

#define LBMSDM_TYPE_MODIFIER_ARRAY 0x0100
/*!     \brief SDM field type definitions.
*/
enum
{
        /*! SDM field type: Type is invalid. */
        LBMSDM_TYPE_INVALID = 0,
        /*! SDM field type: Boolean (non-zero is true, zero is false). */
        LBMSDM_TYPE_BOOLEAN = 1,
        /*! SDM field type: 8-bit signed integer. */
        LBMSDM_TYPE_INT8 = 2,
        /*! SDM field type: 8-bit unsigned integer. */
        LBMSDM_TYPE_UINT8 = 3,
        /*! SDM field type: 16-bit signed integer. */
        LBMSDM_TYPE_INT16 = 4,
        /*! SDM field type: 16-bit unsigned integer. */
        LBMSDM_TYPE_UINT16 = 5,
        /*! SDM field type: 32-bit signed integer. */
        LBMSDM_TYPE_INT32 = 6,
        /*! SDM field type: 32-bit unsigned integer. */
        LBMSDM_TYPE_UINT32 = 7,
        /*! SDM field type: 64-bit signed integer. */
        LBMSDM_TYPE_INT64 = 8,
        /*! SDM field type: 64-bit unsigned integer. */
        LBMSDM_TYPE_UINT64 = 9,
        /*! SDM field type: Single-precision floating point. */
        LBMSDM_TYPE_FLOAT = 10,
        /*! SDM field type: Double-precision floating point. */
        LBMSDM_TYPE_DOUBLE = 11,
        /*! SDM field type: Decimal number. */
        LBMSDM_TYPE_DECIMAL = 12,
        /*! SDM field type: Seconds and microseconds since the epoch (UTC). */
        LBMSDM_TYPE_TIMESTAMP = 13,
        /*! SDM field type: Nested SDM message. */
        LBMSDM_TYPE_MESSAGE = 14,
        /*! SDM field type: Character string (ASCIZ). */
        LBMSDM_TYPE_STRING = 15,
        /*! SDM field type: Unicode string. */
        LBMSDM_TYPE_UNICODE = 16,
        /*! SDM field type: Binary Large Object (BLOB). */
        LBMSDM_TYPE_BLOB = 17,
        /*! SDM field type: Array of Booleans (non-zero is true, zero is false). */
        LBMSDM_TYPE_ARRAY_BOOLEAN = LBMSDM_TYPE_BOOLEAN | LBMSDM_TYPE_MODIFIER_ARRAY,
        /*! SDM field type: Array of 8-bit signed integers. */
        LBMSDM_TYPE_ARRAY_INT8 = LBMSDM_TYPE_INT8 | LBMSDM_TYPE_MODIFIER_ARRAY,
        /*! SDM field type: Array of 8-bit unsigned integers. */
        LBMSDM_TYPE_ARRAY_UINT8 =  (LBMSDM_TYPE_UINT8 | LBMSDM_TYPE_MODIFIER_ARRAY),
        /*! SDM field type: Array of 16-bit signed integers. */
        LBMSDM_TYPE_ARRAY_INT16 = (LBMSDM_TYPE_INT16 | LBMSDM_TYPE_MODIFIER_ARRAY),
        /*! SDM field type: Array of 16-bit unsigned integers. */
        LBMSDM_TYPE_ARRAY_UINT16 = (LBMSDM_TYPE_UINT16 | LBMSDM_TYPE_MODIFIER_ARRAY),
        /*! SDM field type: Array of 32-bit signed integers. */
        LBMSDM_TYPE_ARRAY_INT32 = (LBMSDM_TYPE_INT32 | LBMSDM_TYPE_MODIFIER_ARRAY),
        /*! SDM field type: Array of 32-bit unsigned integers. */
        LBMSDM_TYPE_ARRAY_UINT32 = (LBMSDM_TYPE_UINT32 | LBMSDM_TYPE_MODIFIER_ARRAY),
        /*! SDM field type: Array of 64-bit signed integers. */
        LBMSDM_TYPE_ARRAY_INT64 = (LBMSDM_TYPE_INT64 | LBMSDM_TYPE_MODIFIER_ARRAY),
        /*! SDM field type: Array of 64-bit unsigned integers. */
        LBMSDM_TYPE_ARRAY_UINT64 = (LBMSDM_TYPE_UINT64 | LBMSDM_TYPE_MODIFIER_ARRAY),
        /*! SDM field type: Array of single-precision floating points. */
        LBMSDM_TYPE_ARRAY_FLOAT = (LBMSDM_TYPE_FLOAT | LBMSDM_TYPE_MODIFIER_ARRAY),
        /*! SDM field type: Array of double-precision floating points. */
        LBMSDM_TYPE_ARRAY_DOUBLE = (LBMSDM_TYPE_DOUBLE | LBMSDM_TYPE_MODIFIER_ARRAY),
        /*! SDM field type: Array of decimal numbers. */
        LBMSDM_TYPE_ARRAY_DECIMAL = (LBMSDM_TYPE_DECIMAL | LBMSDM_TYPE_MODIFIER_ARRAY),
        /*! SDM field type: Array of timestamps (seconds and microseconds since the epoch (UTC)). */
        LBMSDM_TYPE_ARRAY_TIMESTAMP = (LBMSDM_TYPE_TIMESTAMP | LBMSDM_TYPE_MODIFIER_ARRAY),
        /*! SDM field type: Array of nested SDM messages. */
        LBMSDM_TYPE_ARRAY_MESSAGE = (LBMSDM_TYPE_MESSAGE | LBMSDM_TYPE_MODIFIER_ARRAY),
        /*! SDM field type: Array of character strings (ASCIZ). */
        LBMSDM_TYPE_ARRAY_STRING = (LBMSDM_TYPE_STRING | LBMSDM_TYPE_MODIFIER_ARRAY),
        /*! SDM field type: Array of unicode strings. */
        LBMSDM_TYPE_ARRAY_UNICODE = (LBMSDM_TYPE_UNICODE | LBMSDM_TYPE_MODIFIER_ARRAY),
        /*! SDM field type: Array of Binary Large Objects (BLOB). */
        LBMSDM_TYPE_ARRAY_BLOB = (LBMSDM_TYPE_BLOB | LBMSDM_TYPE_MODIFIER_ARRAY)
};

/*!     \brief SDM API function return codes.
*/
enum
{
        /*! SDM return code: Operation was successful. */
        LBMSDM_SUCCESS = 0,
        /*! SDM return code: Operation failed. See ::lbmsdm_errnum() or ::lbmsdm_errmsg() for the reason. */
        LBMSDM_FAILURE = -1,
        /*! SDM return code: Field is null. */
        LBMSDM_FIELD_IS_NULL = 1,
        /*! SDM return code: No more fields to iterate over. */
        LBMSDM_NO_MORE_FIELDS = 2,
        /*! SDM return code: Insufficient buffer length given. */
        LBMSDM_INSUFFICIENT_BUFFER_LENGTH = 3
};

/*!     \brief SDM error codes.
*/
enum
{
        /*! SDM error code: An invalid argument was passed. */
        LBMSDM_ERR_EINVAL = 1,
        /*! SDM error code: Operation could not be completed due to memory allocation error. */
        LBMSDM_ERR_ENOMEM,
        /*! SDM error code: Field name is too long. */
        LBMSDM_ERR_NAMETOOLONG,
        /*! SDM error code: The field being added to the message already exists. */
        LBMSDM_ERR_DUPLICATE_FIELD,
        /*! SDM error code: Invalid type. */
        LBMSDM_ERR_BAD_TYPE,
        /*! SDM error code: The field does not exist in the message. */
        LBMSDM_ERR_FIELD_NOT_FOUND,
        /*! SDM error code: The message is in an invalid form. */
        LBMSDM_ERR_MSG_INVALID,
        /*! SDM error code: The field can not be converted as requested. */
        LBMSDM_ERR_CANNOT_CONVERT,
        /*! SDM error code: The field is not an array field. */
        LBMSDM_ERR_NOT_ARRAY,
        /*! SDM error code: The field is not a scalar field. */
        LBMSDM_ERR_NOT_SCALAR,
        /*! SDM error code: The specified array element does not exist. */
        LBMSDM_ERR_ELEMENT_NOT_FOUND,
        /*! SDM error code: The specified type is not supported. */
        LBMSDM_ERR_TYPE_NOT_SUPPORTED,
        /*! SDM error code: Type mismatch. */
        LBMSDM_ERR_TYPE_MISMATCH,
        /*! SDM error code: Unicode conversion error. */
        LBMSDM_ERR_UNICODE_CONVERSION,
        /*! SDM error code: Field is null. */
        LBMSDM_ERR_FIELD_IS_NULL,
        /*! SDM error code: Unable to add field. */
        LBMSDM_ERR_ADDING_FIELD,
        /*! SDM error code: Iterator doesn't reference a valid field. */
        LBMSDM_ERR_ITERATOR_INVALID,
        /*! SDM error code: Error deleting a field. */
        LBMSDM_ERR_DELETING_FIELD,
        /*! SDM error code: Invalid field name. */
        LBMSDM_ERR_INVALID_FIELD_NAME
};

/*!     \brief Structure to hold a scaled decimal number.
        A scaled decimal number consists of a mantissa \f$m\f$ and an exponent \f$exp\f$.
        It represents the value \f$m\cdot 10^{exp}\f$.

        The mantissa is represented as a 64-bit signed integer.
        The exponent is represented as an 8-bit signed integer,
        and can range from -128 to 127.
*/
typedef struct lbmsdm_decimal_t_stct
{
        /*! Mantissa. */
        int64_t mant;
        /*! Exponent. */
        int8_t exp;
} lbmsdm_decimal_t;

/*!     \brief Return the error number last encountered by this thread.
        \return Integer error number (see LBMSDM_ERROR_*).
*/
LBMSDMExpDLL int lbmsdm_errnum(void);

/*!     \brief Return an ASCII string containing the error message last encountered
                by this thread.
        \return Pointer to a static char array containing the error message.
*/
LBMSDMExpDLL const char * lbmsdm_errmsg(void);

#if defined(_WIN32) || defined(DOXYGEN)
/*!     \brief Perform required initialization under Windows.
                This function needs to be called before any other LBM SDM API function,
                but only when using the static version of the LBM SDM library on Windows.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_win32_static_init(void);
#endif

/*!     \brief Create an SDM message to be filled in and sent.
        \param Message A pointer to a pointer to an SDM message object.
                Will be filled in by this function to point to the newly created
                ::lbmsdm_msg_t object.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_create(lbmsdm_msg_t * * Message);

/*!     \brief Create an SDM message to be filled in and sent, with options.
        \param Message A pointer to a pointer to an SDM message object.
                Will be filled in by this function to point to the newly created
                ::lbmsdm_msg_t object.
        \param Attributes A pointer to an ::lbmsdm_msg_attr_t structure used to initialize
                the message options.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_create_ex(lbmsdm_msg_t * * Message, const lbmsdm_msg_attr_t * Attributes);

/*!     \brief Create an SDM message to be parsed and processed from an existing buffer.
        \param Message A pointer to a pointer to an SDM message object.
                Will be filled in by this function to point to the newly created
                ::lbmsdm_msg_t object.
        \param Data A pointer to the buffer from which the message should be constructed.
        \param Length Length of \a Data.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_parse(lbmsdm_msg_t * * Message, const char * Data, size_t Length);

/*!     \brief Create an SDM message to be parsed and processed from an existing buffer, with options.
        \param Message A pointer to a pointer to an SDM message object.
                Will be filled in by this function to point to the newly created
                ::lbmsdm_msg_t object.
        \param Data A pointer to the buffer from which the message should be constructed.
        \param Length Length of \a Data.
        \param Attributes A pointer to an ::lbmsdm_msg_attr_t structure used to initialize
                the message options.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_parse_ex(lbmsdm_msg_t * * Message, const char * Data, size_t Length, const lbmsdm_msg_attr_t * Attributes);

/*!     \brief Create an SDM message to be parsed and processed from an existing buffer, using
                an already-existing ::lbmsdm_msg_t structure.
        \param Message A pointer to an existing SDM message object,
                into which the message buffer is parsed.
                The message will be cleared before parsing.
        \param Data A pointer to the buffer from which the message should be constructed.
        \param Length Length of \a Data.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_parse_reuse(lbmsdm_msg_t * Message, const char * Data, size_t Length);

/*!     \brief Clone an existing SDM message.
        \param Message A pointer to a pointer to an SDM message object.
                Will be filled in by this function to point to the newly created
                ::lbmsdm_msg_t object.
        \param Original The SDM message to be cloned.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_clone(lbmsdm_msg_t * * Message, const lbmsdm_msg_t * Original);

/*!     \brief Clear an SDM message, deleting all fields in the message.
        \param Message The SDM message to clear.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_clear(lbmsdm_msg_t * Message);

/*!     \brief Destroy an SDM message object.
        \param Message The SDM message to destroy.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_destroy(lbmsdm_msg_t * Message);

/*!     \brief Dump a message into a printable string.
        \param Message The SDM message to dump.
        \param Buffer Buffer into which to dump the message.
        \param Size Maximum size of \a Buffer.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
        \note \a Buffer will be null-terminated. If \a Buffer isn't large enough to contain
                the entire message, it will be truncated to fit the available space.
                The values for unicode and BLOB fields will not formatted.
*/
LBMSDMExpDLL int lbmsdm_msg_dump(lbmsdm_msg_t * Message, char * Buffer, size_t Size);

/*!     \defgroup add  Add a field to a message
        The functions in this group allow scalar (non-array) fields to be added to a message.
        The field value is also specified.
*/
/*!     \brief Add a field to a message.
        \ingroup add
        \param Message The SDM message to which the field is to be added.
        \param Name Name of the field to be added.
        \param Value Value of the field to be added.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_add_boolean(lbmsdm_msg_t * Message, const char * Name, uint8_t Value);

/*!     \ingroup add
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_int8(lbmsdm_msg_t * Message, const char * Name, int8_t Value);

/*!     \ingroup add
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_uint8(lbmsdm_msg_t * Message, const char * Name, uint8_t Value);

/*!     \ingroup add
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_int16(lbmsdm_msg_t * Message, const char * Name, int16_t Value);

/*!     \ingroup add
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_uint16(lbmsdm_msg_t * Message, const char * Name, uint16_t Value);

/*!     \ingroup add
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_int32(lbmsdm_msg_t * Message, const char * Name, int32_t Value);

/*!     \ingroup add
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_uint32(lbmsdm_msg_t * Message, const char * Name, uint32_t Value);

/*!     \ingroup add
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_int64(lbmsdm_msg_t * Message, const char * Name, int64_t Value);

/*!     \ingroup add
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_uint64(lbmsdm_msg_t * Message, const char * Name, uint64_t Value);

/*!     \ingroup add
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_float(lbmsdm_msg_t * Message, const char * Name, float Value);

/*!     \ingroup add
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_double(lbmsdm_msg_t * Message, const char * Name, double Value);

/*!     \ingroup add
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_decimal(lbmsdm_msg_t * Message, const char * Name, const lbmsdm_decimal_t * Value);

/*!     \ingroup add
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_timestamp(lbmsdm_msg_t * Message, const char * Name, const struct timeval * Value);

/*!     \ingroup add
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_message(lbmsdm_msg_t * Message, const char * Name, const lbmsdm_msg_t * Value);

/*!     \ingroup add
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_string(lbmsdm_msg_t * Message, const char * Name, const char * Value);

/*!     \brief Add a unicode field to a message.
        \ingroup add
        \param Message The SDM message to which the field is to be added.
        \param Name Name of the field to be added.
        \param Value Value of the field to be added.
        \param Length Length of the unicode string, in <tt>wchar_t</tt>s.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_add_unicode(lbmsdm_msg_t * Message, const char * Name, const wchar_t * Value, size_t Length);

/*!     \brief Add a BLOB field to a message.
        \ingroup add
        \param Message The SDM message to which the field is to be added.
        \param Name Name of the field to be added.
        \param Value Value of the field to be added.
        \param Length Length of the data, in bytes.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_add_blob(lbmsdm_msg_t * Message, const char * Name, const void * Value, size_t Length);

/*!     \defgroup add_array Add an array field to a message
        The functions in this group allow array fields to be added to a message.
*/
/*!     \brief Add an array field to a message.
        \ingroup add_array
        \param Message The SDM message to which the field is to be added.
        \param Name Name of the field to be added.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_add_boolean_array(lbmsdm_msg_t * Message, const char * Name);

/*!     \ingroup add_array
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_int8_array(lbmsdm_msg_t * Message, const char * Name);

/*!     \ingroup add_array
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_uint8_array(lbmsdm_msg_t * Message, const char * Name);

/*!     \ingroup add_array
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_int16_array(lbmsdm_msg_t * Message, const char * Name);

/*!     \ingroup add_array
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_uint16_array(lbmsdm_msg_t * Message, const char * Name);

/*!     \ingroup add_array
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_int32_array(lbmsdm_msg_t * Message, const char * Name);

/*!     \ingroup add_array
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_uint32_array(lbmsdm_msg_t * Message, const char * Name);

/*!     \ingroup add_array
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_int64_array(lbmsdm_msg_t * Message, const char * Name);

/*!     \ingroup add_array
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_uint64_array(lbmsdm_msg_t * Message, const char * Name);

/*!     \ingroup add_array
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_float_array(lbmsdm_msg_t * Message, const char * Name);

/*!     \ingroup add_array
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_double_array(lbmsdm_msg_t * Message, const char * Name);

/*!     \ingroup add_array
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_decimal_array(lbmsdm_msg_t * Message, const char * Name);

/*!     \ingroup add_array
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_timestamp_array(lbmsdm_msg_t * Message, const char * Name);

/*!     \ingroup add_array
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_message_array(lbmsdm_msg_t * Message, const char * Name);

/*!     \ingroup add_array
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_string_array(lbmsdm_msg_t * Message, const char * Name);

/*!     \ingroup add_array
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_unicode_array(lbmsdm_msg_t * Message, const char * Name);

/*!     \ingroup add_array
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_blob_array(lbmsdm_msg_t * Message, const char * Name);

/*!     \defgroup add_elem_idx Add an element to an array field by field index
        The functions in this group allow an element to be added to an array field
        referenced by field index.
*/
/*!     \brief Set the value of an array field element in a message by field index.
        \ingroup add_elem_idx
        \param Message The SDM message containing the field.
        \param Index Field index.
        \param Value Element value.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_add_boolean_elem_idx(lbmsdm_msg_t * Message, size_t Index, uint8_t Value);

/*!     \ingroup add_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_int8_elem_idx(lbmsdm_msg_t * Message, size_t Index, int8_t Value);

/*!     \ingroup add_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_uint8_elem_idx(lbmsdm_msg_t * Message, size_t Index, uint8_t Value);

/*!     \ingroup add_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_int16_elem_idx(lbmsdm_msg_t * Message, size_t Index, int16_t Value);

/*!     \ingroup add_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_uint16_elem_idx(lbmsdm_msg_t * Message, size_t Index, uint16_t Value);

/*!     \ingroup add_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_int32_elem_idx(lbmsdm_msg_t * Message, size_t Index, int32_t Value);

/*!     \ingroup add_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_uint32_elem_idx(lbmsdm_msg_t * Message, size_t Index, uint32_t Value);

/*!     \ingroup add_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_int64_elem_idx(lbmsdm_msg_t * Message, size_t Index, int64_t Value);

/*!     \ingroup add_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_uint64_elem_idx(lbmsdm_msg_t * Message, size_t Index, uint64_t Value);

/*!     \ingroup add_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_float_elem_idx(lbmsdm_msg_t * Message, size_t Index, float Value);

/*!     \ingroup add_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_double_elem_idx(lbmsdm_msg_t * Message, size_t Index, double Value);

/*!     \ingroup add_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_decimal_elem_idx(lbmsdm_msg_t * Message, size_t Index, const lbmsdm_decimal_t * Value);

/*!     \ingroup add_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_timestamp_elem_idx(lbmsdm_msg_t * Message, size_t Index, const struct timeval * Value);

/*!     \ingroup add_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_message_elem_idx(lbmsdm_msg_t * Message, size_t Index, const lbmsdm_msg_t * Value);

/*!     \ingroup add_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_string_elem_idx(lbmsdm_msg_t * Message, size_t Index, const char * Value);

/*!     \brief Set the value of a unicode array field element in a message by field index.
        \ingroup add_elem_idx
        \param Message The SDM message containing the field.
        \param Index Field index.
        \param Value Element value.
        \param Length Length of the unicode string, in <tt>wchar_t</tt>s.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_add_unicode_elem_idx(lbmsdm_msg_t * Message, size_t Index, const wchar_t * Value, size_t Length);

/*!     \brief Set the value of a blob array field element in a message by field index.
        \ingroup add_elem_idx
        \param Message The SDM message containing the field.
        \param Index Field index.
        \param Value Element value.
        \param Length Length of the BLOB value, in bytes.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_add_blob_elem_idx(lbmsdm_msg_t * Message, size_t Index, const void * Value, size_t Length);

/*!     \defgroup add_elem_name Add an element to an array field by field name
        The functions in this group allow an element to be added to an array field
        referenced by field name.
*/
/*!     \brief Add an array field element in a message by field name.
        \ingroup add_elem_name
        \param Message The SDM message containing the field.
        \param Name Field name.
        \param Value Element value.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_add_boolean_elem_name(lbmsdm_msg_t * Message, const char * Name, uint8_t Value);

/*!     \ingroup add_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_int8_elem_name(lbmsdm_msg_t * Message, const char * Name, int8_t Value);

/*!     \ingroup add_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_uint8_elem_name(lbmsdm_msg_t * Message, const char * Name, uint8_t Value);

/*!     \ingroup add_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_int16_elem_name(lbmsdm_msg_t * Message, const char * Name, int16_t Value);

/*!     \ingroup add_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_uint16_elem_name(lbmsdm_msg_t * Message, const char * Name, uint16_t Value);

/*!     \ingroup add_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_int32_elem_name(lbmsdm_msg_t * Message, const char * Name, int32_t Value);

/*!     \ingroup add_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_uint32_elem_name(lbmsdm_msg_t * Message, const char * Name, uint32_t Value);

/*!     \ingroup add_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_int64_elem_name(lbmsdm_msg_t * Message, const char * Name, int64_t Value);

/*!     \ingroup add_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_uint64_elem_name(lbmsdm_msg_t * Message, const char * Name, uint64_t Value);

/*!     \ingroup add_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_float_elem_name(lbmsdm_msg_t * Message, const char * Name, float Value);

/*!     \ingroup add_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_double_elem_name(lbmsdm_msg_t * Message, const char * Name, double Value);

/*!     \ingroup add_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_decimal_elem_name(lbmsdm_msg_t * Message, const char * Name, const lbmsdm_decimal_t * Value);

/*!     \ingroup add_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_timestamp_elem_name(lbmsdm_msg_t * Message, const char * Name, const struct timeval * Value);

/*!     \ingroup add_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_message_elem_name(lbmsdm_msg_t * Message, const char * Name, const lbmsdm_msg_t * Value);

/*!     \ingroup add_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_add_string_elem_name(lbmsdm_msg_t * Message, const char * Name, const char * Value);

/*!     \brief Add a unicode array field element in a message by field name.
        \ingroup add_elem_name
        \param Message The SDM message containing the field.
        \param Name Field name.
        \param Value Element value.
        \param Length Length of the unicode string, in <tt>wchar_t</tt>s.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_add_unicode_elem_name(lbmsdm_msg_t * Message, const char * Name, const wchar_t * Value, size_t Length);

/*!     \brief Add a BLOB array field element in a message by field name.
        \ingroup add_elem_name
        \param Message The SDM message containing the field.
        \param Name Field name.
        \param Value Element value.
        \param Length Length of the BLOB data, in bytes.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_add_blob_elem_name(lbmsdm_msg_t * Message, const char * Name, const void * Value, size_t Length);

/*!     \defgroup add_elem_iter Add an element to an array field referenced by an iterator
        The functions in this group allow an element to be added to an array field
        referenced by an iterator.
*/
/*!     \brief Add an array field element in a message referenced by an iterator.
        \ingroup add_elem_iter
        \param Iterator The iterator referencing the field.
        \param Value Element value.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_add_boolean_elem(lbmsdm_iter_t * Iterator, uint8_t Value);

/*!     \ingroup add_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_add_int8_elem(lbmsdm_iter_t * Iterator, int8_t Value);

/*!     \ingroup add_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_add_uint8_elem(lbmsdm_iter_t * Iterator, uint8_t Value);

/*!     \ingroup add_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_add_int16_elem(lbmsdm_iter_t * Iterator, int16_t Value);

/*!     \ingroup add_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_add_uint16_elem(lbmsdm_iter_t * Iterator, uint16_t Value);

/*!     \ingroup add_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_add_int32_elem(lbmsdm_iter_t * Iterator, int32_t Value);

/*!     \ingroup add_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_add_uint32_elem(lbmsdm_iter_t * Iterator, uint32_t Value);

/*!     \ingroup add_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_add_int64_elem(lbmsdm_iter_t * Iterator, int64_t Value);

/*!     \ingroup add_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_add_uint64_elem(lbmsdm_iter_t * Iterator, uint64_t Value);

/*!     \ingroup add_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_add_float_elem(lbmsdm_iter_t * Iterator, float Value);

/*!     \ingroup add_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_add_double_elem(lbmsdm_iter_t * Iterator, double Value);

/*!     \ingroup add_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_add_decimal_elem(lbmsdm_iter_t * Iterator, const lbmsdm_decimal_t * Value);

/*!     \ingroup add_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_add_timestamp_elem(lbmsdm_iter_t * Iterator, const struct timeval * Value);

/*!     \ingroup add_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_add_message_elem(lbmsdm_iter_t * Iterator, const lbmsdm_msg_t * Value);

/*!     \ingroup add_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_add_string_elem(lbmsdm_iter_t * Iterator, const char * Value);

/*!     \brief Add a unicode array field element in a message referenced by an iterator.
        \ingroup add_elem_iter
        \param Iterator The iterator referencing the field.
        \param Value Element value.
        \param Length Length of the unicode string, in <tt>wchar_t</tt>s.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_add_unicode_elem(lbmsdm_iter_t * Iterator, const wchar_t * Value, size_t Length);

/*!     \brief Add a BLOB array field element in a message referenced by an iterator.
        \ingroup add_elem_iter
        \param Iterator The iterator referencing the field.
        \param Value Element value.
        \param Length Length of the BLOB data, in bytes.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_add_blob_elem(lbmsdm_iter_t * Iterator, const void * Value, size_t Length);

/*!     \brief Get the data buffer for a constructed message,
                after all fields have been added to the message.
        \param Message The SDM message.
        \return A pointer to the data buffer,
                or \c NULL if any error occurs.
        \note The pointer returned by ::lbmsdm_msg_get_data is invalidated when the message is deleted
                (via ::lbmsdm_msg_destroy), any field is added to the message,
                any field is deleted from the message, or any field in the message is changed
                (either the field value or type).
                In other words, any time the message is changed, the pointer returned is no longer valid.
*/
LBMSDMExpDLL const char * lbmsdm_msg_get_data(lbmsdm_msg_t * Message);

/*!     \brief Get the length of the data buffer for a constructed message,
                after all fields have been added to the message.
        \param Message The SDM message.
        \return The length of the data buffer,
                or 0 if any error occurs.
*/
LBMSDMExpDLL size_t lbmsdm_msg_get_datalen(lbmsdm_msg_t * Message);

/*!     \brief Get the number of fields in a message.
        \param Message The SDM message.
        \return The number of fields in the message, or -1 if an error occurs.
        \note Only top-level fields are counted. If a message field exists within the message,
                the number of fields in the contained message are not counted. Instead, the message
                field counts as one field. Likewise, array fields contribute only 1 to the field count,
                not the number of elements in the field.
*/
LBMSDMExpDLL int lbmsdm_msg_get_fldcnt(lbmsdm_msg_t * Message);

/*!     \brief Create an SDM message iterator.
        \param Iterator A pointer to a pointer to an SDM iterator object.
                Will be filled in by this function to point to the newly created
                ::lbmsdm_iter_t object.
        \param Message SDM message on which the iterator is to operate.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_create(lbmsdm_iter_t * * Iterator, lbmsdm_msg_t * Message);

/*!     \brief Destroy an SDM message iterator.
        \param Iterator The ::lbmsdm_iter_t object to destroy.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_destroy(lbmsdm_iter_t * Iterator);

/*!     \brief Position an iterator to the first field in the message.
        \param Iterator The iterator to position.
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_NO_MORE_FIELDS if no fields exist in the message
        \retval ::LBMSDM_FAILURE if the operation failed
*/
LBMSDMExpDLL int lbmsdm_iter_first(lbmsdm_iter_t * Iterator);

/*!     \brief Position an iterator to the next field in the message.
        \param Iterator The iterator to position.
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_NO_MORE_FIELDS if no fields exist in the message
        \retval ::LBMSDM_FAILURE if the operation failed
*/
LBMSDMExpDLL int lbmsdm_iter_next(lbmsdm_iter_t * Iterator);

/*!     \brief Get the name of a field in a message by field index.
        \param Message The SDM message from which the field name is to be fetched.
        \param Index Field index.
        \return The field name, or \c NULL if an error occurred.
*/
LBMSDMExpDLL const char * lbmsdm_msg_get_name_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \brief Get the index of a field in a message by field name.
        \param Message The SDM message from which the field name is to be fetched.
        \param Name Field name.
        \return The field index, or \c -1 if an error occurred.
*/
LBMSDMExpDLL int lbmsdm_msg_get_idx_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \brief Get the name of the current field for an iterator.
        \param Iterator The SDM iterator.
        \return The field name, or \c NULL if an error occurred.
*/
LBMSDMExpDLL const char * lbmsdm_iter_get_name(lbmsdm_iter_t * Iterator);

/*!     \brief Get the type of a field in a message by field name.
        \param Message The SDM message from which the field type is to be fetched.
        \param Name Field name.
        \return The field type, or ::LBMSDM_TYPE_INVALID if an error occurred.
*/
LBMSDMExpDLL lbmsdm_field_type_t lbmsdm_msg_get_type_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \brief Get the type of a field in a message by field index.
        \param Message The SDM message from which the field type is to be fetched.
        \param Index Field index.
        \return The field type, or ::LBMSDM_TYPE_INVALID if an error occurred.
*/
LBMSDMExpDLL lbmsdm_field_type_t lbmsdm_msg_get_type_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \brief Get the type of the current field for an iterator.
        \param Iterator The SDM iterator.
        \return The field type, or ::LBMSDM_TYPE_INVALID if an error occurred.
*/
LBMSDMExpDLL lbmsdm_field_type_t lbmsdm_iter_get_type(lbmsdm_iter_t * Iterator);

/*!     \brief Determine if a field in a message is null, by field name.
        \param Message The SDM message containing the field.
        \param Name Field name.
        \retval 1 if the field is null.
        \retval 0 if the field is present and not null.
        \retval ::LBMSDM_FAILURE if an error occurred.
*/
LBMSDMExpDLL int lbmsdm_msg_is_null_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \brief Determine if a field in a message is null, by field index.
        \param Message The SDM message containing the field.
        \param Index Field index.
        \retval 1 if the field is null.
        \retval 0 if the field is present and not null.
        \retval ::LBMSDM_FAILURE if an error occurred.
*/
LBMSDMExpDLL int lbmsdm_msg_is_null_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \brief Determine if the field referenced by an iterator is null.
        \param Iterator The SDM iterator.
        \retval 1 if the field is null.
        \retval 0 if the field is present and not null.
        \retval ::LBMSDM_FAILURE if an error occurred.
*/
LBMSDMExpDLL int lbmsdm_iter_is_null(lbmsdm_iter_t * Iterator);

/*!     \brief Get the number of elements in an array field in a message by field name.
        \param Message The SDM message from which the array size is to be fetched.
        \param Name Field name.
        \return The number of elements in the array, or -1 if an error occurred.
        \note Calling this function for a non-array field will return 1 for the number
                of elements.
*/
LBMSDMExpDLL int lbmsdm_msg_get_elemcnt_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \brief Get the number of elements in an array field by field index.
        \param Message The SDM message from which the array size is to be fetched.
        \param Index Field index.
        \return The number of elements in the array, or -1 if an error occurred.
        \note Calling this function for a non-array field will return 1 for the number
                of elements.
*/
LBMSDMExpDLL int lbmsdm_msg_get_elemcnt_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \brief Get the number of elements in the current array field for an iterator.
        \param Iterator The SDM iterator.
        \return The number of elements in the array, or -1 if an error occurred.
        \note Calling this function for a non-array field will return 1 for the number
                of elements.
*/
LBMSDMExpDLL int lbmsdm_iter_get_elemcnt(lbmsdm_iter_t * Iterator);

/*!     \brief Get the length (in bytes) required for a field in a message by field name.
        \param Message The SDM message containing the field.
        \param Name Field name.
        \return The number of bytes required to store the field, or -1 if an error occurred.
        \note Calling this function for an array field will return -1.
        \sa lbmsdm_msg_get_field_array_size_name_elem()
*/
LBMSDMExpDLL int lbmsdm_msg_get_len_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \brief Get the length (in bytes) required for a field in a message by field index.
        \param Message The SDM message containing the field.
        \param Index Field index.
        \return The number of bytes required to store the field, or -1 if an error occurred.
        \note Calling this function for an array field will return -1.
        \sa lbmsdm_msg_get_field_array_size_index_elem()
*/
LBMSDMExpDLL int lbmsdm_msg_get_len_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \brief Get the length (in bytes) required for the current field for an iterator.
        \param Iterator The SDM iterator.
        \return The number of bytes required to store the field, or -1 if an error occurred.
        \note Calling this function for an array field will return -1.
        \sa lbmsdm_iter_get_field_array_size_index_elem()
*/
LBMSDMExpDLL int lbmsdm_iter_get_len(lbmsdm_iter_t * Iterator);

/*!     \brief Get the length (in bytes) required for an array field element in a message by field name.
        \param Message The SDM message containing the field.
        \param Name Field name.
        \param Element Element index (zero-based).
        \return The number of bytes required to store the field, or -1 if an error occurred.
*/
LBMSDMExpDLL int lbmsdm_msg_get_elemlen_name(lbmsdm_msg_t * Message, const char * Name, size_t Element);

/*!     \brief Get the length (in bytes) required for an array field element in a message by field index.
        \param Message The SDM message containing the field.
        \param Index Field index.
        \param Element Element index (zero-based).
        \return The number of bytes required to store the field, or -1 if an error occurred.
*/
LBMSDMExpDLL int lbmsdm_msg_get_elemlen_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element);

/*!     \brief Get the length (in bytes) required for an element of the current array field for an iterator.
        \param Iterator The SDM iterator.
        \param Element Element index (zero-based).
        \return The number of bytes required to store the field, or -1 if an error occurred.
*/
LBMSDMExpDLL int lbmsdm_iter_get_elemlen(lbmsdm_iter_t * Iterator, size_t Element);

/*!     \defgroup get_scalar_idx  Get scalar field values by field index
        The functions in this group allow the retrieval of the value of a scalar (non-array) field,
        referenced by field index.
*/
/*!     \brief Fetch a field value from a message by field index.
        \ingroup get_scalar_idx
        \param Message The SDM message from which the field is to be fetched.
        \param Index Field index.
        \param Value Pointer to variable where the value is stored.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_get_boolean_idx(lbmsdm_msg_t * Message, size_t Index, uint8_t * Value);

/*!     \overload
        \ingroup get_scalar_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_int8_idx(lbmsdm_msg_t * Message, size_t Index, int8_t * Value);

/*!     \overload
        \ingroup get_scalar_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_uint8_idx(lbmsdm_msg_t * Message, size_t Index, uint8_t * Value);

/*!     \overload
        \ingroup get_scalar_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_int16_idx(lbmsdm_msg_t * Message, size_t Index, int16_t * Value);

/*!     \overload
        \ingroup get_scalar_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_uint16_idx(lbmsdm_msg_t * Message, size_t Index, uint16_t * Value);

/*!     \overload
        \ingroup get_scalar_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_int32_idx(lbmsdm_msg_t * Message, size_t Index, int32_t * Value);

/*!     \overload
        \ingroup get_scalar_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_uint32_idx(lbmsdm_msg_t * Message, size_t Index, uint32_t * Value);

/*!     \overload
        \ingroup get_scalar_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_int64_idx(lbmsdm_msg_t * Message, size_t Index, int64_t * Value);

/*!     \overload
        \ingroup get_scalar_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_uint64_idx(lbmsdm_msg_t * Message, size_t Index, uint64_t * Value);

/*!     \overload
        \ingroup get_scalar_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_float_idx(lbmsdm_msg_t * Message, size_t Index, float * Value);

/*!     \overload
        \ingroup get_scalar_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_double_idx(lbmsdm_msg_t * Message, size_t Index, double * Value);

/*!     \overload
        \ingroup get_scalar_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_decimal_idx(lbmsdm_msg_t * Message, size_t Index, lbmsdm_decimal_t * Value);

/*!     \overload
        \ingroup get_scalar_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_timestamp_idx(lbmsdm_msg_t * Message, size_t Index, struct timeval * Value);

/*!     \overload
        \ingroup get_scalar_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_message_idx(lbmsdm_msg_t * Message, size_t Index, lbmsdm_msg_t * * Value);

/*!     \brief Fetch a string field value from a message by field index.
        \ingroup get_scalar_idx
        \param Message The SDM message from which the field is to be fetched.
        \param Index Field index.
        \param Value Pointer to variable where the value is stored.
        \param Size Pointer to a variable containing the maximum size of \a Value (including the
                terminating null character).
                On exit, it will contain the actual size of the string (including the terminating
                null character).
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH if \a Size is not large enough for the string.
                \a Size will contain the length required.
        \retval ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_get_string_idx(lbmsdm_msg_t * Message, size_t Index, char * Value, size_t * Size);

/*!     \brief Fetch a unicode field value from a message by field index.
        \ingroup get_scalar_idx
        \param Message The SDM message from which the field is to be fetched.
        \param Index Field index.
        \param Value Pointer to variable where the value is stored.
        \param Size Pointer to a variable containing the maximum size of \a Value in <tt>wchar_t</tt>s.
                On exit, it will contain the actual size of \a Value in <tt>wchar_t</tt>s.
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH if \a Size is not large enough for the data.
                \a Size will contain the length required.
        \retval ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_get_unicode_idx(lbmsdm_msg_t * Message, size_t Index, wchar_t * Value, size_t * Size);

/*!     \brief Fetch a BLOB field value from a message by field index.
        \ingroup get_scalar_idx
        \param Message The SDM message from which the field is to be fetched.
        \param Index Field index.
        \param Value Pointer to variable where the value is stored.
        \param Size Pointer to a variable containing the maximum size of \a Value in bytes.
                On exit, it will contain the actual size of \a Value.
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH if \a Size is not large enough for the data.
                \a Size will contain the length required.
        \retval ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_get_blob_idx(lbmsdm_msg_t * Message, size_t Index, void * Value, size_t * Size);

/*!     \defgroup get_scalar_name  Get scalar field values by field name
        The functions in this group allow the retrieval of the value of a scalar (non-array) field,
        referenced by field name.
*/
/*!     \brief Fetch a field value from a message by field name.
        \ingroup get_scalar_name
        \param Message The SDM message from which the field is to be fetched.
        \param Name Field name.
        \param Value Pointer to variable where the value is stored.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_get_boolean_name(lbmsdm_msg_t * Message, const char * Name, uint8_t * Value);

/*!     \overload
        \ingroup get_scalar_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_int8_name(lbmsdm_msg_t * Message, const char * Name, int8_t * Value);

/*!     \overload
        \ingroup get_scalar_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_uint8_name(lbmsdm_msg_t * Message, const char * Name, uint8_t * Value);

/*!     \overload
        \ingroup get_scalar_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_int16_name(lbmsdm_msg_t * Message, const char * Name, int16_t * Value);

/*!     \overload
        \ingroup get_scalar_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_uint16_name(lbmsdm_msg_t * Message, const char * Name, uint16_t * Value);

/*!     \overload
        \ingroup get_scalar_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_int32_name(lbmsdm_msg_t * Message, const char * Name, int32_t * Value);

/*!     \overload
        \ingroup get_scalar_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_uint32_name(lbmsdm_msg_t * Message, const char * Name, uint32_t * Value);

/*!     \overload
        \ingroup get_scalar_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_int64_name(lbmsdm_msg_t * Message, const char * Name, int64_t * Value);

/*!     \overload
        \ingroup get_scalar_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_uint64_name(lbmsdm_msg_t * Message, const char * Name, uint64_t * Value);

/*!     \overload
        \ingroup get_scalar_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_float_name(lbmsdm_msg_t * Message, const char * Name, float * Value);

/*!     \overload
        \ingroup get_scalar_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_double_name(lbmsdm_msg_t * Message, const char * Name, double * Value);

/*!     \overload
        \ingroup get_scalar_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_decimal_name(lbmsdm_msg_t * Message, const char * Name, lbmsdm_decimal_t * Value);

/*!     \overload
        \ingroup get_scalar_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_timestamp_name(lbmsdm_msg_t * Message, const char * Name, struct timeval * Value);

/*!     \overload
        \ingroup get_scalar_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_message_name(lbmsdm_msg_t * Message, const char * Name, lbmsdm_msg_t * * Value);

/*!     \brief Fetch a string field value from a message by field name.
        \ingroup get_scalar_name
        \param Message The SDM message from which the field is to be fetched.
        \param Name Field name.
        \param Value Pointer to variable where the value is stored.
        \param Size Pointer to a variable containing the maximum size of \a Value (including the
                terminating null character).
                On exit, it will contain the actual size of the string (including the terminating
                null character).
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH if \a Size is not large enough for the string.
                \a Size will contain the length required.
        \retval ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_get_string_name(lbmsdm_msg_t * Message, const char * Name, char * Value, size_t * Size);

/*!     \brief Fetch a unicode field value from a message by field name.
        \ingroup get_scalar_name
        \param Message The SDM message from which the field is to be fetched.
        \param Name Field name.
        \param Value Pointer to variable where the value is stored.
        \param Size Pointer to a variable containing the maximum size of \a Value in <tt>wchar_t</tt>s.
                On exit, it will contain the actual size of the data in <tt>wchar_t</tt>s
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH if \a Size is not large enough for the string.
                \a Size will contain the length required in <tt>wchar_t</tt>s.
        \retval ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_get_unicode_name(lbmsdm_msg_t * Message, const char * Name, wchar_t * Value, size_t * Size);

/*!     \brief Fetch a BLOB field value from a message by field name.
        \ingroup get_scalar_name
        \param Message The SDM message from which the field is to be fetched.
        \param Name Field name.
        \param Value Pointer to variable where the value is stored.
        \param Size Pointer to a variable containing the maximum size of \a Value in bytes.
                On exit, it will contain the actual size of the data.
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH if \a Size is not large enough for the string.
                \a Size will contain the length required in bytes.
        \retval ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_get_blob_name(lbmsdm_msg_t * Message, const char * Name, void * Value, size_t * Size);

/*!     \defgroup get_scalar_iter Get a scalar field via an iterator
        The functions in this group allow the retrieval of the value of a scalar (non-array) field,
        referenced by an iterator.
*/
/*!     \brief Fetch a field value from the field referenced by an iterator.
        \ingroup get_scalar_iter
        \param Iterator The SDM iterator to use.
        \param Value Pointer to variable where the value is stored.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_get_boolean(lbmsdm_iter_t * Iterator, uint8_t * Value);

/*!     \overload
        \ingroup get_scalar_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_int8(lbmsdm_iter_t * Iterator, int8_t * Value);

/*!     \overload
        \ingroup get_scalar_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_uint8(lbmsdm_iter_t * Iterator, uint8_t * Value);

/*!     \overload
        \ingroup get_scalar_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_int16(lbmsdm_iter_t * Iterator, int16_t * Value);

/*!     \overload
        \ingroup get_scalar_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_uint16(lbmsdm_iter_t * Iterator, uint16_t * Value);

/*!     \overload
        \ingroup get_scalar_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_int32(lbmsdm_iter_t * Iterator, int32_t * Value);

/*!     \overload
        \ingroup get_scalar_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_uint32(lbmsdm_iter_t * Iterator, uint32_t * Value);

/*!     \overload
        \ingroup get_scalar_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_int64(lbmsdm_iter_t * Iterator, int64_t * Value);

/*!     \overload
        \ingroup get_scalar_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_uint64(lbmsdm_iter_t * Iterator, uint64_t * Value);

/*!     \overload
        \ingroup get_scalar_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_float(lbmsdm_iter_t * Iterator, float * Value);

/*!     \overload
        \ingroup get_scalar_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_double(lbmsdm_iter_t * Iterator, double * Value);

/*!     \overload
        \ingroup get_scalar_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_decimal(lbmsdm_iter_t * Iterator, lbmsdm_decimal_t * Value);

/*!     \overload
        \ingroup get_scalar_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_timestamp(lbmsdm_iter_t * Iterator, struct timeval * Value);

/*!     \overload
        \ingroup get_scalar_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_message(lbmsdm_iter_t * Iterator, lbmsdm_msg_t * * Value);

/*!     \brief Fetch a string field value from the field referenced by an iterator.
        \ingroup get_scalar_iter
        \param Iterator The SDM iterator to use.
        \param Value Pointer to variable where the value is stored.
        \param Size Pointer to a variable containing the maximum size of \a Value (including the
                terminating null character).
                On exit, it will contain the actual size of the string (including the terminating
                null character).
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH if \a Size is not large enough for the string.
                \a Size will contain the length required.
        \retval ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_get_string(lbmsdm_iter_t * Iterator, char * Value, size_t * Size);

/*!     \brief Fetch a unicode field value from the field referenced by an iterator.
        \ingroup get_scalar_iter
        \param Iterator The SDM iterator to use.
        \param Value Pointer to variable where the value is stored.
        \param Size Pointer to a variable containing the maximum size of \a Value in <tt>wchar_t</tt>s.
                On exit, it will contain the actual size of the data in <tt>wchar_t</tt>s.
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH if \a Size is not large enough for the data.
                \a Size will contain the length required in <tt>wchar_t</tt>s.
        \retval ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_get_unicode(lbmsdm_iter_t * Iterator, wchar_t * Value, size_t * Size);

/*!     \brief Fetch a BLOB field value from the field referenced by an iterator.
        \ingroup get_scalar_iter
        \param Iterator The SDM iterator to use.
        \param Value Pointer to variable where the value is stored.
        \param Size Pointer to a variable containing the maximum size of \a Value in bytes.
                On exit, it will contain the actual size of the data.
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH if \a Size is not large enough for the data.
                \a Size will contain the length required in bytes.
        \retval ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_get_blob(lbmsdm_iter_t * Iterator, void * Value, size_t * Size);

/*!     \defgroup get_elem_idx Get an element from an array field by field index
        The functions in this group allow the retrieval of an element value of an array field,
        referenced by field index.
*/
/*!     \brief Fetch an array field element value from a message by field index.
        \ingroup get_elem_idx
        \param Message The SDM message from which the field is to be fetched.
        \param Index Field index.
        \param Element Element number (zero-based).
        \param Value Pointer to variable where the value is stored.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_get_boolean_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, uint8_t * Value);

/*!     \overload
        \ingroup get_elem_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_int8_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, int8_t * Value);

/*!     \overload
        \ingroup get_elem_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_uint8_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, uint8_t * Value);

/*!     \overload
        \ingroup get_elem_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_int16_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, int16_t * Value);

/*!     \overload
        \ingroup get_elem_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_uint16_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, uint16_t * Value);

/*!     \overload
        \ingroup get_elem_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_int32_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, int32_t * Value);

/*!     \overload
        \ingroup get_elem_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_uint32_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, uint32_t * Value);

/*!     \overload
        \ingroup get_elem_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_int64_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, int64_t * Value);

/*!     \overload
        \ingroup get_elem_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_uint64_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, uint64_t * Value);

/*!     \overload
        \ingroup get_elem_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_float_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, float * Value);

/*!     \overload
        \ingroup get_elem_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_double_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, double * Value);

/*!     \overload
        \ingroup get_elem_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_decimal_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, lbmsdm_decimal_t * Value);

/*!     \overload
        \ingroup get_elem_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_timestamp_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, struct timeval * Value);

/*!     \overload
        \ingroup get_elem_idx
*/
LBMSDMExpDLL int lbmsdm_msg_get_message_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, lbmsdm_msg_t * * Value);

/*!     \brief Fetch a string array field element value from a message by field index.
        \ingroup get_elem_idx
        \param Message The SDM message from which the field is to be fetched.
        \param Index Field index.
        \param Element Element number (zero-based).
        \param Value Pointer to variable where the value is stored.
        \param Size Pointer to a variable containing the maximum size of \a Value (including the
                terminating null character).
                On exit, it will contain the actual size of the string (including the terminating
                null character).
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH if \a Size is not large enough for the string.
                \a Size will contain the length required.
        \retval ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_get_string_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, char * Value, size_t * Size);

/*!     \brief Fetch a unicode array field element value from a message by field index.
        \ingroup get_elem_idx
        \param Message The SDM message from which the field is to be fetched.
        \param Index Field index.
        \param Element Element number (zero-based).
        \param Value Pointer to variable where the value is stored.
        \param Size Pointer to a variable containing the maximum size of \a Value in <tt>wchar_t</tt>s.
                On exit, it will contain the actual size of the data in <tt>wchar_t</tt>s.
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH if \a Size is not large enough for the data.
                \a Size will contain the length required in <tt>wchar_t</tt>s.
        \retval ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_get_unicode_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, wchar_t * Value, size_t * Size);

/*!     \brief Fetch a BLOB array field element value from a message by field index.
        \ingroup get_elem_idx
        \param Message The SDM message from which the field is to be fetched.
        \param Index Field index.
        \param Element Element number (zero-based).
        \param Value Pointer to variable where the value is stored.
        \param Size Pointer to a variable containing the maximum size of \a Value in bytes..
                On exit, it will contain the actual size of the data.
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH if \a Size is not large enough for the data.
                \a Size will contain the length required in bytes.
        \retval ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_get_blob_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, void * Value, size_t * Size);

/*!     \defgroup get_elem_name Get an element from an array field by field name
        The functions in this group allow the retrieval of an element value of an array field,
        referenced by field name.
*/
/*!     \brief Fetch an array field element value from a message by field name.
        \ingroup get_elem_name
        \param Message The SDM message from which the field is to be fetched.
        \param Name Field name.
        \param Element Element number (zero-based).
        \param Value Pointer to variable where the value is stored.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_get_boolean_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, uint8_t * Value);

/*!     \overload
        \ingroup get_elem_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_int8_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, int8_t * Value);

/*!     \overload
        \ingroup get_elem_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_uint8_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, uint8_t * Value);

/*!     \overload
        \ingroup get_elem_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_int16_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, int16_t * Value);

/*!     \overload
        \ingroup get_elem_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_uint16_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, uint16_t * Value);

/*!     \overload
        \ingroup get_elem_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_int32_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, int32_t * Value);

/*!     \overload
        \ingroup get_elem_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_uint32_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, uint32_t * Value);

/*!     \overload
        \ingroup get_elem_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_int64_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, int64_t * Value);

/*!     \overload
        \ingroup get_elem_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_uint64_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, uint64_t * Value);

/*!     \overload
        \ingroup get_elem_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_float_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, float * Value);

/*!     \overload
        \ingroup get_elem_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_double_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, double * Value);

/*!     \overload
        \ingroup get_elem_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_decimal_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, lbmsdm_decimal_t * Value);

/*!     \overload
        \ingroup get_elem_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_timestamp_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, struct timeval * Value);

/*!     \overload
        \ingroup get_elem_name
*/
LBMSDMExpDLL int lbmsdm_msg_get_message_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, lbmsdm_msg_t * * Value);

/*!     \brief Fetch a string array field element value from a message by field name.
        \ingroup get_elem_name
        \param Message The SDM message from which the field is to be fetched.
        \param Name Field name.
        \param Element Element number (zero-based).
        \param Value Pointer to variable where the value is stored.
        \param Size Pointer to a variable containing the maximum size of \a Value (including the
                terminating null character).
                On exit, it will contain the actual size of the string (including the terminating
                null character).
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH if \a Size is not large enough for the string.
                \a Size will contain the length required.
        \retval ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_get_string_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, char * Value, size_t * Size);

/*!     \brief Fetch a unicode array field element value from a message by field name.
        \ingroup get_elem_name
        \param Message The SDM message from which the field is to be fetched.
        \param Name Field name.
        \param Element Element number (zero-based).
        \param Value Pointer to variable where the value is stored.
        \param Size Pointer to a variable containing the maximum size of \a Value in <tt>wchar_t</tt>s.
                On exit, it will contain the actual size of the data.
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH if \a Size is not large enough for the data.
                \a Size will contain the length required in <tt>wchar_t</tt>s.
        \retval ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_get_unicode_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, wchar_t * Value, size_t * Size);

/*!     \brief Fetch a BLOB array field element value from a message by field name.
        \ingroup get_elem_name
        \param Message The SDM message from which the field is to be fetched.
        \param Name Field name.
        \param Element Element number (zero-based).
        \param Value Pointer to variable where the value is stored.
        \param Size Pointer to a variable containing the maximum size of \a Value in bytes.
                On exit, it will contain the actual size of the data.
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH if \a Size is not large enough for the data.
                \a Size will contain the length required in bytes.
        \retval ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_get_blob_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, void * Value, size_t * Size);


/*!     \defgroup get_elem_iter Get an element from an array field referenced by an iterator
        The functions in this group allow the retrieval of an element value of an array field,
        referenced by an iterator.
*/
/*!     \brief Fetch an array field element value from the field referenced by an iterator.
        \ingroup get_elem_iter
        \param Iterator The SDM iterator to use.
        \param Element Element number (zero-based).
        \param Value Pointer to variable where the value is stored.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_get_boolean_elem(lbmsdm_iter_t * Iterator, size_t Element, uint8_t * Value);

/*!     \overload
        \ingroup get_elem_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_int8_elem(lbmsdm_iter_t * Iterator, size_t Element, int8_t * Value);

/*!     \overload
        \ingroup get_elem_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_uint8_elem(lbmsdm_iter_t * Iterator, size_t Element, uint8_t * Value);

/*!     \overload
        \ingroup get_elem_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_int16_elem(lbmsdm_iter_t * Iterator, size_t Element, int16_t * Value);

/*!     \overload
        \ingroup get_elem_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_uint16_elem(lbmsdm_iter_t * Iterator, size_t Element, uint16_t * Value);

/*!     \overload
        \ingroup get_elem_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_int32_elem(lbmsdm_iter_t * Iterator, size_t Element, int32_t * Value);

/*!     \overload
        \ingroup get_elem_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_uint32_elem(lbmsdm_iter_t * Iterator, size_t Element, uint32_t * Value);

/*!     \overload
        \ingroup get_elem_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_int64_elem(lbmsdm_iter_t * Iterator, size_t Element, int64_t * Value);

/*!     \overload
        \ingroup get_elem_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_uint64_elem(lbmsdm_iter_t * Iterator, size_t Element, uint64_t * Value);

/*!     \overload
        \ingroup get_elem_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_float_elem(lbmsdm_iter_t * Iterator, size_t Element, float * Value);

/*!     \overload
        \ingroup get_elem_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_double_elem(lbmsdm_iter_t * Iterator, size_t Element, double * Value);

/*!     \overload
        \ingroup get_elem_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_decimal_elem(lbmsdm_iter_t * Iterator, size_t Element, lbmsdm_decimal_t * Value);

/*!     \overload
        \ingroup get_elem_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_timestamp_elem(lbmsdm_iter_t * Iterator, size_t Element, struct timeval * Value);

/*!     \overload
        \ingroup get_elem_iter
*/
LBMSDMExpDLL int lbmsdm_iter_get_message_elem(lbmsdm_iter_t * Iterator, size_t Element, lbmsdm_msg_t * * Value);

/*!     \brief Fetch a string array field element value from the field referenced by an iterator.
        \ingroup get_elem_iter
        \param Iterator The SDM iterator to use.
        \param Element Element number (zero-based).
        \param Value Pointer to variable where the value is stored.
        \param Size Pointer to a variable containing the maximum size of \a Value (including the
                terminating null character).
                On exit, it will contain the actual size of the string (including the terminating
                null character).
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH if \a Size is not large enough for the string.
                \a Size will contain the length required.
        \retval ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_get_string_elem(lbmsdm_iter_t * Iterator, size_t Element, char * Value, size_t * Size);

/*!     \brief Fetch a unicode array field element value from the field referenced by an iterator.
        \ingroup get_elem_iter
        \param Iterator The SDM iterator to use.
        \param Element Element number (zero-based).
        \param Value Pointer to variable where the value is stored.
        \param Size Pointer to a variable containing the maximum size of \a Value in <tt>wchar_t</tt>s.
                On exit, it will contain the actual size of the data.
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH if \a Size is not large enough for the data.
                \a Size will contain the length required in <tt>wchar_t</tt>s.
        \retval ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_get_unicode_elem(lbmsdm_iter_t * Iterator, size_t Element, wchar_t * Value, size_t * Size);

/*!     \brief Fetch a blob array field element value from the field referenced by an iterator.
        \ingroup get_elem_iter
        \param Iterator The SDM iterator to use.
        \param Element Element number (zero-based).
        \param Value Pointer to variable where the value is stored.
        \param Size Pointer to a variable containing the maximum size of \a Value in bytes.
                On exit, it will contain the actual size of the data.
        \retval ::LBMSDM_SUCCESS if successful
        \retval ::LBMSDM_INSUFFICIENT_BUFFER_LENGTH if \a Size is not large enough for the data.
                \a Size will contain the length required in bytes.
        \retval ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_get_blob_elem(lbmsdm_iter_t * Iterator, size_t Element, void * Value, size_t * Size);

/*!     \brief Set a field in a message to null, by field name.
        \param Message The SDM message containing the field.
        \param Name Field name.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_set_null_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \brief Set a field in a message to null, by field index.
        \param Message The SDM message containing the field.
        \param Index Field index.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_set_null_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \brief Set the field referenced by an iterator to null.
        \param Iterator The SDM iterator.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_set_null(lbmsdm_iter_t * Iterator);


/*!     \defgroup set_idx Set a field value in a message by field index
        The functions in this group allow the value of a field to be set,
        and the type of the field to be set to a scalar type,
        for a field referenced by field index.
*/
/*!     \brief Set a field value in a message by field index.
        \ingroup set_idx
        \param Message The SDM message containing the field.
        \param Index Field index.
        \param Value Pointer to variable containing the value.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_set_boolean_idx(lbmsdm_msg_t * Message, size_t Index, uint8_t Value);

/*!     \overload
        \ingroup set_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_int8_idx(lbmsdm_msg_t * Message, size_t Index, int8_t Value);

/*!     \overload
        \ingroup set_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint8_idx(lbmsdm_msg_t * Message, size_t Index, uint8_t Value);

/*!     \overload
        \ingroup set_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_int16_idx(lbmsdm_msg_t * Message, size_t Index, int16_t Value);

/*!     \overload
        \ingroup set_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint16_idx(lbmsdm_msg_t * Message, size_t Index, uint16_t Value);

/*!     \overload
        \ingroup set_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_int32_idx(lbmsdm_msg_t * Message, size_t Index, int32_t Value);

/*!     \overload
        \ingroup set_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint32_idx(lbmsdm_msg_t * Message, size_t Index, uint32_t Value);

/*!     \overload
        \ingroup set_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_int64_idx(lbmsdm_msg_t * Message, size_t Index, int64_t Value);

/*!     \overload
        \ingroup set_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint64_idx(lbmsdm_msg_t * Message, size_t Index, uint64_t Value);

/*!     \overload
        \ingroup set_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_float_idx(lbmsdm_msg_t * Message, size_t Index, float Value);

/*!     \overload
        \ingroup set_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_double_idx(lbmsdm_msg_t * Message, size_t Index, double Value);

/*!     \overload
        \ingroup set_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_decimal_idx(lbmsdm_msg_t * Message, size_t Index, const lbmsdm_decimal_t * Value);

/*!     \overload
        \ingroup set_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_timestamp_idx(lbmsdm_msg_t * Message, size_t Index, const struct timeval * Value);

/*!     \overload
        \ingroup set_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_message_idx(lbmsdm_msg_t * Message, size_t Index, const lbmsdm_msg_t * Value);

/*!     \overload
        \ingroup set_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_string_idx(lbmsdm_msg_t * Message, size_t Index, const char * Value);

/*!     \brief Set a unicode field value in a message by field index.
        \ingroup set_idx
        \param Message The SDM message containing the field.
        \param Index Field index.
        \param Value Pointer to variable containing the value.
        \param Length Length of \a Value in <tt>wchar_t</tt>s.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_set_unicode_idx(lbmsdm_msg_t * Message, size_t Index, const wchar_t * Value, size_t Length);

/*!     \brief Set a BLOB field value in a message by field index.
        \ingroup set_idx
        \param Message The SDM message containing the field.
        \param Index Field index.
        \param Value Pointer to variable containing the value.
        \param Length Length of \a Value in bytes.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_set_blob_idx(lbmsdm_msg_t * Message, size_t Index, const void * Value, size_t Length);

/*!     \defgroup set_name Set a field value in a message by field name
        The functions in this group allow the value of a field to be set,
        and the type of the field to be set to a scalar type,
        for a field referenced by field name.
*/
/*!     \brief Set a field value in a message by field name.
        \ingroup set_name
        \param Message The SDM message containing the field.
        \param Name Field name.
        \param Value New field value.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_set_boolean_name(lbmsdm_msg_t * Message, const char * Name, uint8_t Value);

/*!     \overload
        \ingroup set_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_int8_name(lbmsdm_msg_t * Message, const char * Name, int8_t Value);

/*!     \overload
        \ingroup set_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint8_name(lbmsdm_msg_t * Message, const char * Name, uint8_t Value);

/*!     \overload
        \ingroup set_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_int16_name(lbmsdm_msg_t * Message, const char * Name, int16_t Value);

/*!     \overload
        \ingroup set_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint16_name(lbmsdm_msg_t * Message, const char * Name, uint16_t Value);

/*!     \overload
        \ingroup set_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_int32_name(lbmsdm_msg_t * Message, const char * Name, int32_t Value);

/*!     \overload
        \ingroup set_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint32_name(lbmsdm_msg_t * Message, const char * Name, uint32_t Value);

/*!     \overload
        \ingroup set_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_int64_name(lbmsdm_msg_t * Message, const char * Name, int64_t Value);

/*!     \overload
        \ingroup set_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint64_name(lbmsdm_msg_t * Message, const char * Name, uint64_t Value);

/*!     \overload
        \ingroup set_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_float_name(lbmsdm_msg_t * Message, const char * Name, float Value);

/*!     \overload
        \ingroup set_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_double_name(lbmsdm_msg_t * Message, const char * Name, double Value);

/*!     \overload
        \ingroup set_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_decimal_name(lbmsdm_msg_t * Message, const char * Name, const lbmsdm_decimal_t * Value);

/*!     \overload
        \ingroup set_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_timestamp_name(lbmsdm_msg_t * Message, const char * Name, const struct timeval * Value);

/*!     \overload
        \ingroup set_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_message_name(lbmsdm_msg_t * Message, const char * Name, const lbmsdm_msg_t * Value);

/*!     \overload
        \ingroup set_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_string_name(lbmsdm_msg_t * Message, const char * Name, const char * Value);

/*!     \brief Set a unicode field value in a message by field name.
        \ingroup set_name
        \param Message The SDM message containing the field.
        \param Name Field name.
        \param Value New value.
        \param Length Length of \a Value in <tt>wchar_t</tt>s.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_set_unicode_name(lbmsdm_msg_t * Message, const char * Name, const wchar_t * Value, size_t Length);

/*!     \brief Set a BLOB field value in a message by field name.
        \ingroup set_name
        \param Message The SDM message containing the field.
        \param Name Field name.
        \param Value New value.
        \param Length Length of \a Value in bytes.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_set_blob_name(lbmsdm_msg_t * Message, const char * Name, const void * Value, size_t Length);

/*!     \defgroup set_iter Set a field value in a message referenced by an iterator
        The functions in this group allow the value of a field to be set,
        and the type of the field to be set to a scalar type,
        for a field referenced by an iterator.
*/
/*!     \brief Set a field value in the field referenced by an iterator.
        \ingroup set_iter
        \param Iterator The SDM iterator to use.
        \param Value The new field value.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_set_boolean(lbmsdm_iter_t * Iterator, uint8_t Value);

/*!     \overload
        \ingroup set_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_int8(lbmsdm_iter_t * Iterator, int8_t Value);

/*!     \overload
        \ingroup set_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_uint8(lbmsdm_iter_t * Iterator, uint8_t Value);

/*!     \overload
        \ingroup set_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_int16(lbmsdm_iter_t * Iterator, int16_t Value);

/*!     \overload
        \ingroup set_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_uint16(lbmsdm_iter_t * Iterator, uint16_t Value);

/*!     \overload
        \ingroup set_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_int32(lbmsdm_iter_t * Iterator, int32_t Value);

/*!     \overload
        \ingroup set_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_uint32(lbmsdm_iter_t * Iterator, uint32_t Value);

/*!     \overload
        \ingroup set_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_int64(lbmsdm_iter_t * Iterator, int64_t Value);

/*!     \overload
        \ingroup set_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_uint64(lbmsdm_iter_t * Iterator, uint64_t Value);

/*!     \overload
        \ingroup set_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_float(lbmsdm_iter_t * Iterator, float Value);

/*!     \overload
        \ingroup set_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_double(lbmsdm_iter_t * Iterator, double Value);

/*!     \overload
        \ingroup set_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_decimal(lbmsdm_iter_t * Iterator, const lbmsdm_decimal_t * Value);

/*!     \overload
        \ingroup set_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_timestamp(lbmsdm_iter_t * Iterator, const struct timeval * Value);

/*!     \overload
        \ingroup set_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_message(lbmsdm_iter_t * Iterator, const lbmsdm_msg_t * Value);

/*!     \overload
        \ingroup set_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_string(lbmsdm_iter_t * Iterator, const char * Value);

/*!     \brief Set a unicode field value in the field referenced by an iterator.
        \ingroup set_iter
        \param Iterator The SDM iterator to use.
        \param Value New value.
        \param Length Length of \a Value in <tt>wchar_t</tt>s.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_set_unicode(lbmsdm_iter_t * Iterator, const wchar_t * Value, size_t Length);

/*!     \brief Set a BLOB field value in the field referenced by an iterator.
        \ingroup set_iter
        \param Iterator The SDM iterator to use.
        \param Value New value.
        \param Length Length of \a Value in bytes.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_set_blob(lbmsdm_iter_t * Iterator, const void * Value, size_t Length);

/*!     \defgroup set_array_idx Set a field value in a message by field index to an array field
        The functions in this group allow the type of the field to be set to an array type,
        for a field referenced by field index.
*/
/*!     \brief Set a field in a message by field index to an array field.
        \ingroup set_array_idx
        \param Message The SDM message containing the field.
        \param Index Field index.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_set_boolean_array_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \overload
        \ingroup set_array_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_int8_array_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \overload
        \ingroup set_array_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint8_array_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \overload
        \ingroup set_array_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_int16_array_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \overload
        \ingroup set_array_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint16_array_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \overload
        \ingroup set_array_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_int32_array_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \overload
        \ingroup set_array_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint32_array_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \overload
        \ingroup set_array_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_int64_array_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \overload
        \ingroup set_array_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint64_array_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \overload
        \ingroup set_array_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_float_array_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \overload
        \ingroup set_array_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_double_array_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \overload
        \ingroup set_array_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_decimal_array_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \overload
        \ingroup set_array_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_timestamp_array_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \overload
        \ingroup set_array_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_message_array_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \overload
        \ingroup set_array_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_string_array_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \overload
        \ingroup set_array_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_unicode_array_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \overload
        \ingroup set_array_idx
*/
LBMSDMExpDLL int lbmsdm_msg_set_blob_array_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \defgroup set_array_name Set a field value in a message by field name to an array field
        The functions in this group allow the type of the field to be set to an array type,
        for a field referenced by field name.
*/
/*!     \brief Set a field in a message by field name to an array field.
        \ingroup set_array_name
        \param Message The SDM message containing the field.
        \param Name Field name.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_set_boolean_array_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \overload
        \ingroup set_array_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_int8_array_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \overload
        \ingroup set_array_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint8_array_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \overload
        \ingroup set_array_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_int16_array_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \overload
        \ingroup set_array_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint16_array_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \overload
        \ingroup set_array_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_int32_array_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \overload
        \ingroup set_array_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint32_array_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \overload
        \ingroup set_array_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_int64_array_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \overload
        \ingroup set_array_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint64_array_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \overload
        \ingroup set_array_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_float_array_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \overload
        \ingroup set_array_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_double_array_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \overload
        \ingroup set_array_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_decimal_array_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \overload
        \ingroup set_array_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_timestamp_array_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \overload
        \ingroup set_array_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_message_array_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \overload
        \ingroup set_array_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_string_array_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \overload
        \ingroup set_array_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_unicode_array_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \overload
        \ingroup set_array_name
*/
LBMSDMExpDLL int lbmsdm_msg_set_blob_array_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \defgroup set_array_iter Set a field value in a message, referenced by an iterator, to an array field.
        The functions in this group allow the type of the field to be set to an array type,
        for a field referenced by an iterator.
*/
/*!     \brief Set a field in a message by field name to an array field.
        \ingroup set_array_iter
        \param Iterator The iterator referencing the field.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_set_boolean_array(lbmsdm_iter_t * Iterator);

/*!     \overload
        \ingroup set_array_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_int8_array(lbmsdm_iter_t * Iterator);

/*!     \overload
        \ingroup set_array_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_uint8_array(lbmsdm_iter_t * Iterator);

/*!     \overload
        \ingroup set_array_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_int16_array(lbmsdm_iter_t * Iterator);

/*!     \overload
        \ingroup set_array_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_uint16_array(lbmsdm_iter_t * Iterator);

/*!     \overload
        \ingroup set_array_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_int32_array(lbmsdm_iter_t * Iterator);

/*!     \overload
        \ingroup set_array_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_uint32_array(lbmsdm_iter_t * Iterator);

/*!     \overload
        \ingroup set_array_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_int64_array(lbmsdm_iter_t * Iterator);

/*!     \overload
        \ingroup set_array_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_uint64_array(lbmsdm_iter_t * Iterator);

/*!     \overload
        \ingroup set_array_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_float_array(lbmsdm_iter_t * Iterator);

/*!     \overload
        \ingroup set_array_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_double_array(lbmsdm_iter_t * Iterator);

/*!     \overload
        \ingroup set_array_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_decimal_array(lbmsdm_iter_t * Iterator);

/*!     \overload
        \ingroup set_array_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_timestamp_array(lbmsdm_iter_t * Iterator);

/*!     \overload
        \ingroup set_array_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_message_array(lbmsdm_iter_t * Iterator);

/*!     \overload
        \ingroup set_array_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_string_array(lbmsdm_iter_t * Iterator);

/*!     \overload
        \ingroup set_array_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_unicode_array(lbmsdm_iter_t * Iterator);

/*!     \overload
        \ingroup set_array_iter
*/
LBMSDMExpDLL int lbmsdm_iter_set_blob_array(lbmsdm_iter_t * Iterator);

/*!     \defgroup set_elem_idx Set an array field element value by field index
        The functions in this group allow the value of an element of an array field to be set,
    for a field referenced by field index.
*/
/*!     \brief Set the value of an array field element in a message by field index.
        \ingroup set_elem_idx
        \param Message The SDM message containing the field.
        \param Index Field index.
        \param Element Array element (zero-based).
        \param Value Pointer to variable containing the element value.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_set_boolean_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, uint8_t Value);

/*!     \ingroup set_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_int8_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, int8_t Value);

/*!     \ingroup set_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint8_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, uint8_t Value);

/*!     \ingroup set_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_int16_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, int16_t Value);

/*!     \ingroup set_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint16_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, uint16_t Value);

/*!     \ingroup set_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_int32_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, int32_t Value);

/*!     \ingroup set_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint32_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, uint32_t Value);

/*!     \ingroup set_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_int64_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, int64_t Value);

/*!     \ingroup set_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint64_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, uint64_t Value);

/*!     \ingroup set_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_float_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, float Value);

/*!     \ingroup set_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_double_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, double Value);

/*!     \ingroup set_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_decimal_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, const lbmsdm_decimal_t * Value);

/*!     \ingroup set_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_timestamp_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, const struct timeval * Value);

/*!     \ingroup set_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_message_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, const lbmsdm_msg_t * Value);

/*!     \ingroup set_elem_idx
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_string_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, const char * Value);

/*!     \brief Set the value of a unicode array field element in a message by field index.
        \ingroup set_elem_idx
        \param Message The SDM message containing the field.
        \param Index Field index.
        \param Element Array element (zero-based).
        \param Value Pointer to variable containing the element value.
        \param Length Length of \a Value in <tt>wchar_t</tt>s.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_set_unicode_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, const wchar_t * Value, size_t Length);

/*!     \brief Set the value of a BLOB array field element in a message by field index.
        \ingroup set_elem_idx
        \param Message The SDM message containing the field.
        \param Index Field index.
        \param Element Array element (zero-based).
        \param Value Pointer to variable containing the element value.
        \param Length Length of \a Value in bytes.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_set_blob_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element, const void * Value, size_t Length);

/*!     \defgroup set_elem_name Set an array field element value by field name
        The functions in this group allow the value of an element of an array field to be set,
    for a field referenced by field name.
*/
/*!     \brief Set the value of an array field element in a message by field name.
        \ingroup set_elem_name
        \param Message The SDM message containing the field.
        \param Name Field name.
        \param Element Array element (zero-based).
        \param Value Pointer to variable where the value is stored.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_set_boolean_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, uint8_t Value);

/*!     \ingroup set_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_int8_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, int8_t Value);

/*!     \ingroup set_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint8_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, uint8_t Value);

/*!     \ingroup set_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_int16_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, int16_t Value);

/*!     \ingroup set_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint16_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, uint16_t Value);

/*!     \ingroup set_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_int32_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, int32_t Value);

/*!     \ingroup set_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint32_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, uint32_t Value);

/*!     \ingroup set_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_int64_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, int64_t Value);

/*!     \ingroup set_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_uint64_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, uint64_t Value);

/*!     \ingroup set_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_float_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, float Value);

/*!     \ingroup set_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_double_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, double Value);

/*!     \ingroup set_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_decimal_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, const lbmsdm_decimal_t * Value);

/*!     \ingroup set_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_timestamp_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, const struct timeval * Value);

/*!     \ingroup set_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_message_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, const lbmsdm_msg_t * Value);

/*!     \ingroup set_elem_name
        \overload
*/
LBMSDMExpDLL int lbmsdm_msg_set_string_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, const char * Value);

/*!     \brief Set the value of a unicode array field element in a message by field name.
        \ingroup set_elem_name
        \param Message The SDM message containing the field.
        \param Name Field name.
        \param Element Array element (zero-based).
        \param Value New value.
        \param Length Length of \a Value in <tt>wchar_t</tt>s.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_set_unicode_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, const wchar_t * Value, size_t Length);

/*!     \brief Set the value of a BLOB array field element in a message by field name.
        \ingroup set_elem_name
        \param Message The SDM message containing the field.
        \param Name Field name.
        \param Element Array element (zero-based).
        \param Value New value.
        \param Length Length of \a Value in bytes.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_set_blob_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element, const void * Value, size_t Length);

/*!     \defgroup set_elem_iter Set an array field element value for a field referenced by an iterator
        The functions in this group allow the value of an element of an array field to be set,
    for a field referenced by an iterator.
*/
/*!     \brief Set the value of an array field element in the field referenced by an iterator.
        \ingroup set_elem_iter
        \param Iterator The SDM iterator to use.
        \param Element Array element (zero-based).
        \param Value New field value.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_set_boolean_elem(lbmsdm_iter_t * Iterator, size_t Element, uint8_t Value);

/*!     \ingroup set_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_set_int8_elem(lbmsdm_iter_t * Iterator, size_t Element, int8_t Value);

/*!     \ingroup set_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_set_uint8_elem(lbmsdm_iter_t * Iterator, size_t Element, uint8_t Value);

/*!     \ingroup set_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_set_int16_elem(lbmsdm_iter_t * Iterator, size_t Element, int16_t Value);

/*!     \ingroup set_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_set_uint16_elem(lbmsdm_iter_t * Iterator, size_t Element, uint16_t Value);

/*!     \ingroup set_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_set_int32_elem(lbmsdm_iter_t * Iterator, size_t Element, int32_t Value);

/*!     \ingroup set_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_set_uint32_elem(lbmsdm_iter_t * Iterator, size_t Element, uint32_t Value);

/*!     \ingroup set_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_set_int64_elem(lbmsdm_iter_t * Iterator, size_t Element, int64_t Value);

/*!     \ingroup set_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_set_uint64_elem(lbmsdm_iter_t * Iterator, size_t Element, uint64_t Value);

/*!     \ingroup set_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_set_float_elem(lbmsdm_iter_t * Iterator, size_t Element, float Value);

/*!     \ingroup set_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_set_double_elem(lbmsdm_iter_t * Iterator, size_t Element, double Value);

/*!     \ingroup set_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_set_decimal_elem(lbmsdm_iter_t * Iterator, size_t Element, const lbmsdm_decimal_t * Value);

/*!     \ingroup set_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_set_timestamp_elem(lbmsdm_iter_t * Iterator, size_t Element, const struct timeval * Value);

/*!     \ingroup set_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_set_message_elem(lbmsdm_iter_t * Iterator, size_t Element, const lbmsdm_msg_t * Value);

/*!     \ingroup set_elem_iter
        \overload
*/
LBMSDMExpDLL int lbmsdm_iter_set_string_elem(lbmsdm_iter_t * Iterator, size_t Element, const char * Value);

/*!     \brief Set the value of a unicode array field element in the field referenced by an iterator.
        \ingroup set_elem_iter
        \param Iterator The SDM iterator to use.
        \param Element Array element (zero-based).
        \param Value New field value.
        \param Length Length of \a Value in <tt>wchar_t</tt>s.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_set_unicode_elem(lbmsdm_iter_t * Iterator, size_t Element, const wchar_t * Value, size_t Length);

/*!     \brief Set the value of a BLOB array field element in the field referenced by an iterator.
        \ingroup set_elem_iter
        \param Iterator The SDM iterator to use.
        \param Element Array element (zero-based).
        \param Value New field value.
        \param Length Length of \a Value in bytes.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_set_blob_elem(lbmsdm_iter_t * Iterator, size_t Element, const void * Value, size_t Length);

/*!     \brief Delete a field from a message by field index.
        \param Message The SDM message containing the field.
        \param Index Field index.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_del_idx(lbmsdm_msg_t * Message, size_t Index);

/*!     \brief Delete a field from a message by field name.
        \param Message The SDM message containing the field.
        \param Name Field name.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_del_name(lbmsdm_msg_t * Message, const char * Name);

/*!     \brief Delete a field referenced by an iterator.
        \param Iterator The SDM iterator to use.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_del(lbmsdm_iter_t * Iterator);

/*!     \brief Delete an element from an array field by field index.
        \param Message The SDM message containing the field.
        \param Index Field index.
        \param Element Element to be deleted.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_del_elem_idx(lbmsdm_msg_t * Message, size_t Index, size_t Element);

/*!     \brief Delete an element from an array field by field name.
        \param Message The SDM message containing the field.
        \param Name Field name.
        \param Element Element to be deleted.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_del_elem_name(lbmsdm_msg_t * Message, const char * Name, size_t Element);

/*!     \brief Delete an element from an array field referenced by an iterator.
        \param Iterator The SDM iterator to use.
        \param Element Element to be deleted.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_iter_del_elem(lbmsdm_iter_t * Iterator, size_t Element);

/*!     \brief Create and fill an SDM message attribute object with the default values.

        The attribute object is allocated and filled in with the default values that
        are used by ::lbmsdm_msg_t objects.

        \param Attributes Pointer to a pointer to an SDM message attribute structure.
                Will be filled in by this function to point to the newly created
                ::lbmsdm_msg_attr_t object.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_attr_create(lbmsdm_msg_attr_t * * Attributes);

/*!     \brief Delete an SDM message attribute object.

        The attribute object is cleaned up and deleted.

        \param Attributes Pointer to an SDM message attribute structure as returned
                by ::lbmsdm_msg_attr_create or ::lbmsdm_msg_attr_dup.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_attr_delete(lbmsdm_msg_attr_t * Attributes);

/*!     \brief Duplicate an SDM message attribute object.

        A new attribute object is created as a copy of an existing object.

        \param Attributes Pointer to a pointer to an SDM message attribute structure.
                Will be filled in by this function to point to the newly created
                ::lbmsdm_msg_attr_t object.
        \param Original Pointer to an SDM message attribute structure as returned
                by ::lbmsdm_msg_attr_create or ::lbmsdm_msg_attr_dup,
                from which \a Attributes is initialized.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_attr_dup(lbmsdm_msg_attr_t * * Attributes, lbmsdm_msg_attr_t * Original);

/*!     \brief Set an option for the given SDM message attribute object.

        Used before the message is created.
        NOTE: the attribute object must first be created with ::lbmsdm_msg_attr_create or
        ::lbmsdm_msg_attr_dup.

        \param Attributes Pointer to an SDM message attribute structure.
        \param Option String containing the option name.
        \param Value Pointer to the option value structure.
                The structure of the option value is specific to the option itself.
        \param Length Length (in bytes) of the \Value structure.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_attr_setopt(lbmsdm_msg_attr_t * Attributes, const char * Option, void * Value, size_t Length);

/*!     \brief Set an option for the given SDM message attribute object using a string.

        Used before the message is created.
        NOTE: the attribute object must first be created with ::lbmsdm_msg_attr_create or
        ::lbmsdm_msg_attr_dup.

        \param Attributes Pointer to an SDM message attribute structure.
        \param Option String containing the option name.
        \param Value String containing the option value.
                The format of the string is specific to the option itself.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_attr_str_setopt(lbmsdm_msg_attr_t * Attributes, const char * Option, const char * Value);

/*!     \brief Retrieve the value of an option for the given SDM message attribute.

        \param Attributes Pointer to an SDM message attribute structure.
        \param Option String containing the option name.
        \param Value Pointer to the option value structure to be filled.
                The structure of the option value is specific to the option itself.
        \param Length Length (in bytes) of the \a Value structure when passed in.
                Upon return, this is set to the actual size of the filled-in structure.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_attr_getopt(lbmsdm_msg_attr_t * Attributes, const char * Option, void * Value, size_t * Length);

/*!     \brief Retrieve the value of an option for the given SDM message attribute as a string.

        \param Attributes Pointer to an SDM message attribute structure.
        \param Option String containing the option name.
        \param Value Pointer to the string to be filled in.
        \param Length Maximum length (in bytes) of the \a Value string when passed in.
                Upon return, this is set to the size of the formatted string.
        \return ::LBMSDM_SUCCESS if successful, ::LBMSDM_FAILURE otherwise.
*/
LBMSDMExpDLL int lbmsdm_msg_attr_str_getopt(lbmsdm_msg_attr_t * Attributes, const char * Option, char * Value, size_t * Length);

#if defined(__cplusplus)
}
#endif

#endif

---