1BSON_ITER_DOCUMENT(3)               libbson              BSON_ITER_DOCUMENT(3)
2
3
4

SYNOPSIS

6          #define BSON_ITER_HOLDS_DOCUMENT(iter) \
7             (bson_iter_type ((iter)) == BSON_TYPE_DOCUMENT)
8
9          void
10          bson_iter_document (const bson_iter_t *iter,
11                              uint32_t *document_len,
12                              const uint8_t **document);
13

PARAMETERS

15       • iter: A bson_iter_t.
16
17       • document_len: A location for the length of the document in bytes.
18
19       • document: A location for the document buffer.
20

DESCRIPTION

22       The  bson_iter_document()  function  shall retrieve the raw buffer of a
23       sub-document from iter. iter MUST be on an  element  that  is  of  type
24       BSON_TYPE_DOCUMENT.  This  can be verified with bson_iter_type() or the
25       BSON_ITER_HOLDS_DOCUMENT() macro.
26

AUTHOR

28       MongoDB, Inc
29

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