.\" This manpage is Copyright (C) 2016 MongoDB, Inc.
.\" 
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.3
.\" or any later version published by the Free Software Foundation;
.\" with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
.\" A copy of the license is included in the section entitled "GNU
.\" Free Documentation License".
.\" 
.TH "BSON_ITER_REGEX" "3" "2016\(hy10\(hy12" "libbson"
.SH NAME
bson_iter_regex() \- The bson_iter_regex() function shall retrieve the contents of a BSON_TYPE_REGEX element currently observed by iter.
.SH "SYNOPSIS"

.nf
.nf
const char *
bson_iter_regex (const bson_iter_t *iter,
                 const char       **options);
.fi
.fi

.SH "PARAMETERS"

.TP
.B
iter
A
.B bson_iter_t
.
.LP
.TP
.B
options
A (null).
.LP

.SH "DESCRIPTION"

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

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

.SH "RETURNS"

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


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