bson_iter_regex man page

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

Synopsis

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

Parameters

iter
A bson_iter_t
options
A (null).

Description

The bson_iter_regex(3) 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.

Returns

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

Colophon

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

Info

2016‐10‐28 libbson