Scroll to navigation

BSON_ITER_BINARY_SUBTYPE(3) libbson BSON_ITER_BINARY_SUBTYPE(3)

SYNOPSIS

bson_subtype_t
bson_iter_binary_subtype (const bson_iter_t *iter);


PARAMETERS

iter: A bson_iter_t.

DESCRIPTION

This function shall return the subtype of a BSON_TYPE_BINARY element. It is a programming error to call this function on a field that is not of type BSON_TYPE_BINARY. You can check this with the BSON_ITER_HOLDS_BINARY() macro or bson_iter_type().

Equivalent to the subtype output parameter of bson_iter_binary().

AUTHOR

MongoDB, Inc

COPYRIGHT

2009-present, MongoDB, Inc.

October 8, 2025 2.1.2