table of contents
BSON_ITER_DOCUMENT(3) | libbson | BSON_ITER_DOCUMENT(3) |
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);
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.
DESCRIPTION¶
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.
AUTHOR¶
MongoDB, Inc
COPYRIGHT¶
2009-present, MongoDB, Inc.
November 13, 2024 | 1.29.0 |