plucky (3) bson_string_truncate.3.gz

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

WARNING:
          Deprecated since version 1.29.0.


SYNOPSIS
          void
          bson_string_truncate (bson_string_t *string, uint32_t len);


PARAMETERS
       • string: A bson_string_t.

       • len: The new length of the string, excluding the trailing \0.


DESCRIPTION
       Truncates  the  string  so  that  it is len bytes in length. This must be smaller or equal to the current
       length of the string.

       A \0 byte will be placed where the end of the string occurs.

       WARNING:
          This function is oblivious to UTF-8 structure. If truncation occurs in the  middle  of  a  UTF-8  byte
          sequence, the resulting bson_string_t will contain invalid UTF-8.

       WARNING:
          The length of the resulting string (including the NULL terminator) MUST NOT exceed UINT32_MAX.


AUTHOR
       MongoDB, Inc


       2009-present, MongoDB, Inc.