bson_set_error (3) - Linux Manuals

bson_set_error: This is a helper function to set the parameters of a bson_error_t. It handles the case where error is NULL by doing nothing.

NAME

bson_set_error() - This is a helper function to set the parameters of a bson_error_t. It handles the case where error is NULL by doing nothing.

SYNOPSIS

void
bson_set_error (bson_error_t *error,
                uint32_t      domain,
                uint32_t      code,
                const char   *format,
                ...) BSON_GNUC_PRINTF (4, 5);

PARAMETERS

error
A bson_error_t \&.

domain
A uint32_t \&.

code
A uint32_t \&.

format
A printf(3) style format string.

DESCRIPTION

This is a helper function to set the parameters of a bson_error_t \&. It handles the case where error is NULL by doing nothing.

COLOPHON

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

Pages related to bson_set_error

  • bson_sized_new (3) - The bson_sized_new() function shall create a new bson_t on the heap with a preallocated buffer. This is useful if you have a good idea of the size of the resulting document.
  • bson_snprintf (3) - This is a portable wrapper around snprintf(). It also enforces a trailing   in the resulting 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.
  • 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.