Scroll to navigation

BSON_ITER_OFFSET(3) libbson BSON_ITER_OFFSET(3)

SYNOPSIS

uint32_t
bson_iter_offset (const bson_iter_t *iter);


PARAMETERS

iter: A bson_iter_t <>.

DESCRIPTION

Fetches the offset for the current element observed by iter.

RETURNS

An unsigned integer representing the offset in the BSON data of the current element.

See also:

bson_iter_init_from_data_at_offset() <> to use this offset to reconstruct a bson_iter_t <> in constant time.



Author

MongoDB, Inc

Copyright

2009-present, MongoDB, Inc.

December 11, 2025 2.2.1