bson_string_free (3) - Linux Manuals

bson_string_free: Frees the bson_string_t structure and optionally the string itself.

NAME

bson_string_free() - Frees the bson_string_t structure and optionally the string itself.

SYNOPSIS

char *
bson_string_free (bson_string_t *string,
                  bool           free_segment);

PARAMETERS

string
A bson_string_t \&.

free_segment
A bool indicating if str->str should be returned.

DESCRIPTION

Frees the bson_string_t structure and optionally the string itself.

RETURNS

str->str if free_segment is true, otherwise NULL.

COLOPHON

This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

Pages related to bson_string_free

  • bson_string_append (3) - Appends the ASCII or UTF-8 encoded string str to string. This is not suitable for embedding NULLs in strings.
  • bson_string_append_c (3) - Appends c to the string builder string.
  • bson_string_append_printf (3) - Like bson_string_append() but formats a printf style string and then appends that to string.
  • bson_string_append_unichar (3) - Appends a unicode character to string. The character will be encoded into its multi-byte UTF-8 representation.
  • bson_string_new (3) - Creates a new string builder, which uses power-of-two growth of buffers. Use the various bson_string_append*() functions to append to the string.
  • bson_string_t (3) - String Building Abstraction
  • bson_string_truncate (3) - Truncates the string so that it is len bytes in length. This must be smaller or equal to the current length of the string.
  • bson_strdup (3) - Copies str into a new string. If str is NULL, then NULL is returned.
  • bson_strdup_printf (3) - This function performs a printf style format but into a newly allocated string.
  • bson_strdupv_printf (3) - This function is like bson_strdup_printf() except takes a va_list of parameters.
  • bson_strerror_r (3) - This is a portability wrapper around strerror().
  • bson_strfreev (3) - This will free each string in a NULL-terminated array of strings and then the array itself.