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

SYNOPSIS

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

PARAMETERS

14       • iter: A bson_iter_t.
15
16       • array_len: A location for the buffer length.
17
18       • array: A location for the immutable buffer.
19

DESCRIPTION

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

AUTHOR

27       MongoDB, Inc
28

30       2017-present, MongoDB, Inc
31
32
33
34
351.25.1                           Nov 08, 2023               BSON_ITER_ARRAY(3)
Impressum