1BSON_APPEND_REGEX_W_LEN(3)          libbson         BSON_APPEND_REGEX_W_LEN(3)
2
3
4

SYNOPSIS

6          bool
7          bson_append_regex_w_len (bson_t *bson,
8                                    const char *key,
9                                    int key_length,
10                                    const char *regex,
11                                    int regex_length,
12                                    const char *options);
13

PARAMETERS

15       • bson: A bson_t.
16
17       • key: An ASCII C string containing the name of the field.
18
19       • key_length: The length of key in bytes, or -1 to determine the length
20         with strlen().
21
22       • regex: An ASCII string containing the regex.
23
24       • regex_length: The length of regex in bytes, or -1  to  determine  the
25         length with strlen().
26
27       • options: An optional string containing the regex options as a string.
28

DESCRIPTION

30       Appends  a  new  field to bson of type BSON_TYPE_REGEX. regex should be
31       the regex string. options should contain the options for the regex.
32
33       Valid characters for options include:
34
35       • 'i' for case-insensitive.
36
37       • 'm' for multiple matching.
38
39       • 'x' for verbose mode.
40
41       • 'l' to make w and W locale dependent.
42
43       • 's' for dotall mode ('.' matches everything)
44
45       • 'u' to make w and W match unicode.
46

RETURNS

48       Returns true if the operation was applied  successfully.  The  function
49       will fail if appending the regex grows bson larger than INT32_MAX.
50

AUTHOR

52       MongoDB, Inc
53

55       2017-present, MongoDB, Inc
56
57
58
59
601.25.1                           Nov 08, 2023       BSON_APPEND_REGEX_W_LEN(3)
Impressum