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

NAME

6       bson_iter_code - bson_iter_code()
7

SYNOPSIS

9          #define BSON_ITER_HOLDS_CODE(iter) (bson_iter_type ((iter)) == BSON_TYPE_CODE)
10
11          const char *
12          bson_iter_code (const bson_iter_t *iter, uint32_t *length);
13

PARAMETERS

15       • iter: A bson_iter_t.
16
17       • length:  A  location  for  the  length of the UTF-8 encoded string or
18         NULL.
19

DESCRIPTION

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

RETURNS

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

AUTHOR

31       MongoDB, Inc
32

34       2017-present, MongoDB, Inc
35
36
37
38
391.24.3                           Aug 17, 2023                BSON_ITER_CODE(3)
Impressum