#define BSON_ITER_HOLDS_DOCUMENT(iter) \
Contents
Copyright
2009-present, MongoDB, Inc.
1.30.4 Jun 08, 2025 BSON_ITER_DOCUMENT(3)
Description
The bson_iter_document() function shall retrieve the raw buffer of a sub-document from iter. iterMUST 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.
Parameters
• iter: A bson_iter_t.
• document_len: A location for the length of the document in bytes.
• document: A location for the document buffer.
Synopsis
#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);
