DOKK / manpages / debian 12 / libbson-doc / bson_iter_document.3.en
BSON_ITER_DOCUMENT(3) libbson BSON_ITER_DOCUMENT(3)

bson_iter_document - bson_iter_document()

#define BSON_ITER_HOLDS_DOCUMENT(iter) \


   (bson_iter_type ((iter)) == BSON_TYPE_DOCUMENT)
void
bson_iter_document (const bson_iter_t *iter,


                    uint32_t *document_len,


                    const uint8_t **document);


  • iter: A bson_iter_t.
  • document_len: A location for the length of the document in bytes.
  • document: A location for the document buffer.

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

MongoDB, Inc

2017-present, MongoDB, Inc

October 20, 2022 1.23.1