NAME

       bson_append_regex()  -  Appends  a  new  field to bson of type BSON_TYPE_REGEX. regex should be the regex
       string. options should contain the options for the regex.

SYNOPSIS

       bool
       bson_append_regex (bson_t     *bson,
                          const char *key,
                          int         key_length,
                          const char *regex,
                          const char *options);

PARAMETERS

       bson   A bson_t \&.

       key    An ASCII C string containing the name of the field.

       key_length
              The length of key in bytes, or ‐1 to determine the length with strlen(3) \&.

       regex  An ASCII string containing the regex.

       options
              An optional string containing the regex options as a string.

DESCRIPTION

       Appends a new field to bson of type BSON_TYPE_REGEX.  regex should be the regex string.   options  should
       contain the options for the regex.

       Valid characters for options include:

       \[bu]
         'i' for case‐insensitive.

       \[bu]
         'm' for multiple matching.

       \[bu]
         'x' for verbose mode.

       \[bu]
         'l' to make \w and \W locale dependent.

       \[bu]
         's' for dotall mode ('.' matches everything)

       \[bu]
         'u' to make \w and \W match unicode.

RETURNS

       true if the operation was applied successfully, otherwise false and bson should be discarded.

COLOPHON

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

libbson                                            2016‐01‐18                               BSON_APPEND_REGEX(3)