SYNOPSIS

#include <bson.h>

#define BSON_ITER_HOLDS_REGEX(iter) \
   (bson_iter_type ((iter)) == BSON_TYPE_REGEX)

const char *
bson_iter_regex (const bson_iter_t *iter,
                 const char       **options);

DESCRIPTION

The bson_iter_regex() function shall retrieve the contents of a BSON_TYPE_REGEX element currently observed by iter.

It is invalid to call this function when not observing an element of type BSON_TYPE_REGEX.

RETURN VALUE

A string containing the regex which should not be modified or freed. options is set to the options provided for the regex.

ERRORS

No errors are defined.

SEE ALSO

AUTHORS

This page was written by MongoDB, Inc.