table of contents
- unstable 2.1.0-1
BSON_VECTOR_INT8_VIEW_FROM_ITER(3) | libbson | BSON_VECTOR_INT8_VIEW_FROM_ITER(3) |
Initialize a bson_vector_int8_view_t from a bson_iter_t pointing to a valid Vector of int8 element type.
SYNOPSIS¶
bool bson_vector_int8_view_from_iter (bson_vector_int8_view_t *view_out,
bson_iter_t *iter);
PARAMETERS¶
- view_out: A bson_vector_int8_view_t is written here on success.
- iter: A valid bson_iter_t.
DESCRIPTION¶
The provided iterator, which must point to some kind of BSON item, will be checked for a valid Vector of int8 element type. On success, a bson_vector_int8_view_t is set to point to the same underlying bson_t buffer as the provided bson_iter_t. The view will only be valid until the containing document is destroyed or otherwise modified.
RETURNS¶
Returns true if the view was successfully initialized.
SEE ALSO:
bson_vector_int8_const_view_from_iter()
AUTHOR¶
MongoDB, Inc
COPYRIGHT¶
2009-present, MongoDB, Inc.
August 14, 2025 | 2.1.0 |