bson_iter_array (3) - Linux Manuals

bson_iter_array: The bson_iter_array() function shall retrieve the raw buffer of a sub-array from iter. iter MUST be on an element that is of type BSON_TYPE_ARRAY. This can be verified with bson_iter_type() or the BSON_ITER_HOLDS_ARRAY() macro.

Command to display bson_iter_array manual in Linux: $ man 3 bson_iter_array

NAME

bson_iter_array() - The bson_iter_array() function shall retrieve the raw buffer of a sub-array from iter. iter MUST be on an element that is of type BSON_TYPE_ARRAY. This can be verified with bson_iter_type() or the BSON_ITER_HOLDS_ARRAY() macro.

SYNOPSIS

void
bson_iter_array (const bson_iter_t *iter,
                 uint32_t          *array_len,
                 const uint8_t    **array);

PARAMETERS

iter: A bson_iter_t \&.

array_len: A location for the buffer length.

array: A location for the immutable buffer.

DESCRIPTION

The bson_iter_array(3) function shall retrieve the raw buffer of a sub-array from iter \&. iter

MUST be on an element that is of type BSON_TYPE_ARRAY. This can be verified with bson_iter_type(3) or the BSON_ITER_HOLDS_ARRAY(3) macro.

COLOPHON

This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.