bson_iter_code(3)

NAME

bson_iter_code() – This function returns the contents of a BSON_TYPE_CODE field. The length of the string is stored in length if non-NULL.

SYNOPSIS


#define BSON_ITER_HOLDS_CODE(iter) \
    (bson_iter_type((iter)) == BSON_TYPE_CODE)
const char *
bson_iter_code(const bson_iter_t *iter,
               uint32_t *length);

PARAMETERS

iter: A bson_iter_t \&.

length: A location for the length of the UTF-8 encoded string or NULL.

DESCRIPTION

This function returns the contents of a BSON_TYPE_CODE field. The length of the string is stored in length if non-NULL.

It is invalid to call this function on a field that is not of type BSON_TYPE_CODE.

RETURNS

A UTF-8 encoded string which should not be modified or freed.

COLOPHON

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