SYNOPSIS

#include <bson.h>

#define BSON_ITER_HOLDS_ARRAY(iter) \
   (bson_iter_type ((iter)) == BSON_TYPE_ARRAY)

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

DESCRIPTION

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.

ERRORS

It is a programming error to call this function on an element that is not of BSON_TYPE_ARRAY.

SEE ALSO

AUTHORS

This page was written by MongoDB, Inc.