bson_iter_code(3)

Usage

#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.

Overview

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.

Releases

5 releases since Debian 9 (Stretch); the text changed 4 times.

9
10
11
12
13