1BSON_ITER_CODE(3)                   libbson                  BSON_ITER_CODE(3)
2
3
4

SYNOPSIS

6          #define BSON_ITER_HOLDS_CODE(iter) (bson_iter_type ((iter)) == BSON_TYPE_CODE)
7
8          const char *
9          bson_iter_code (const bson_iter_t *iter, uint32_t *length);
10

PARAMETERS

12iter: A bson_iter_t.
13
14length:  A  location  for  the  length of the UTF-8 encoded string or
15         NULL.
16

DESCRIPTION

18       This function returns the  contents  of  a  BSON_TYPE_CODE  field.  The
19       length of the string is stored in length if non-NULL.
20
21       It  is  invalid  to  call  this function on a field that is not of type
22       BSON_TYPE_CODE.
23

RETURNS

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

AUTHOR

28       MongoDB, Inc
29
31       2017-present, MongoDB, Inc
32
33
34
35
361.25.1                           Nov 08, 2023                BSON_ITER_CODE(3)
Impressum