bionic (3) bson_append_oid.3.gz

Provided by: libbson-doc_1.9.2-1_all bug

NAME
       bson_append_oid - bson_append_oid()


SYNOPSIS
          #define BSON_APPEND_OID(b, key, val) \
             bson_append_oid (b, key, (int) strlen (key), val)

          bool
          bson_append_oid (bson_t *bson,
                           const char *key,
                           int key_length,
                           const bson_oid_t *oid);


PARAMETERS
       • bson: A bson_t.

       • key: An ASCII C string containing the name of the field.

       • key_length: The length of key in bytes, or -1 to determine the length with strlen().

       • oid: A bson_oid_t.


DESCRIPTION
       The  bson_append_oid()  function  shall append a new element to bson of type BSON_TYPE_OID. oid MUST be a
       pointer to a bson_oid_t.


RETURNS
       Returns true if the operation was applied successfully. The function will fail  if  appending  oid  grows
       bson larger than INT32_MAX.


AUTHOR
       MongoDB, Inc


       2018, MongoDB, Inc