.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "BSON_APPEND_REGEX_W_LEN" "3" "Feb 22, 2024" "1.26.0" "libbson"
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
bool
bson_append_regex_w_len (bson_t *bson,
                          const char *key,
                          int key_length,
                          const char *regex,
                          int regex_length,
                          const char *options);
.EE
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBbson\fP: A \fI\%bson_t\fP\&.
.IP \(bu 2
\fBkey\fP: An ASCII C string containing the name of the field.
.IP \(bu 2
\fBkey_length\fP: The length of \fBkey\fP in bytes, or \-1 to determine the length with \fBstrlen()\fP\&.
.IP \(bu 2
\fBregex\fP: An ASCII string containing the regex.
.IP \(bu 2
\fBregex_length\fP: The length of \fBregex\fP in bytes, or \-1 to determine the length with \fBstrlen()\fP\&.
.IP \(bu 2
\fBoptions\fP: An optional string containing the regex options as a string.
.UNINDENT
.SH DESCRIPTION
.sp
Appends a new field to \fBbson\fP of type BSON_TYPE_REGEX. \fBregex\fP should be the regex string. \fBoptions\fP should contain the options for the regex.
.sp
Valid characters for \fBoptions\fP include:
.INDENT 0.0
.IP \(bu 2
\fB\(aqi\(aq\fP for case\-insensitive.
.IP \(bu 2
\fB\(aqm\(aq\fP for multiple matching.
.IP \(bu 2
\fB\(aqx\(aq\fP for verbose mode.
.IP \(bu 2
\fB\(aql\(aq\fP to make w and W locale dependent.
.IP \(bu 2
\fB\(aqs\(aq\fP for dotall mode (\(aq.\(aq matches everything)
.IP \(bu 2
\fB\(aqu\(aq\fP to make w and W match unicode.
.UNINDENT
.SH RETURNS
.sp
Returns \fBtrue\fP if the operation was applied successfully. The function will fail if appending the regex grows \fBbson\fP larger than INT32_MAX.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.