1BSON_ITER_ARRAY(3)                  libbson                 BSON_ITER_ARRAY(3)
2
3
4

NAME

6       bson_iter_array - bson_iter_array()
7

SYNOPSIS

9          #define BSON_ITER_HOLDS_ARRAY(iter) (bson_iter_type ((iter)) == BSON_TYPE_ARRAY)
10
11          void
12          bson_iter_array (const bson_iter_t *iter,
13                           uint32_t *array_len,
14                           const uint8_t **array);
15

PARAMETERS

17       • iter: A bson_iter_t.
18
19       • array_len: A location for the buffer length.
20
21       • array: A location for the immutable buffer.
22

DESCRIPTION

24       The  bson_iter_array()  function  shall  retrieve  the  raw buffer of a
25       sub-array from iter. iter MUST  be  on  an  element  that  is  of  type
26       BSON_TYPE_ARRAY.  This  can  be  verified  with bson_iter_type() or the
27       BSON_ITER_HOLDS_ARRAY() macro.
28

AUTHOR

30       MongoDB, Inc
31

33       2017-present, MongoDB, Inc
34
35
36
37
381.24.3                           Aug 17, 2023               BSON_ITER_ARRAY(3)
Impressum