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

NAME

6       bson_iter_document - bson_iter_document()
7

SYNOPSIS

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

PARAMETERS

18       • iter: A bson_iter_t.
19
20       • document_len: A location for the length of the document in bytes.
21
22       • document: A location for the document buffer.
23

DESCRIPTION

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

AUTHOR

31       MongoDB, Inc
32

34       2017-present, MongoDB, Inc
35
36
37
38
391.17.6                           Jun 03, 2021            BSON_ITER_DOCUMENT(3)
Impressum