Vte.Regex.new_for_search
Description: Reference for Vte.Regex.new_for_search

### Function

# Vte Regexnew_for_search

#### Declaration [src]

    VteRegex*
    vte_regex_new_for_search (
      const char* pattern,
      gssize pattern_length,
      guint32 flags,
      GError** error
    )

#### Description [src]

Compiles `pattern` into a regex for use as a search regex with vte_terminal_search_set_regex().

See man:pcre2pattern(3) for information about the supported regex language, and man:pcre2api(3) for information about the supported `flags`.

The regex will be compiled using PCRE2_UTF and possibly other flags, in addition to the flags supplied in `flags`.

#### Parameters

`pattern`

  Type: `const char*`

  A regex pattern string.

  The data is owned by the caller of the function.
  The value is a NUL terminated UTF-8 string.

`pattern_length`

  Type: `gssize`

  The length of `pattern` in bytes, or -1 if the string is NUL-terminated and the length is unknown.

`flags`

  Type: `guint32`

  PCRE2 compile flags.

`error`

  Type: `GError **`

  The return location for a recoverable error.

  The argument can be `NULL`.
  If the return location is not `NULL`, then you must initialize it to a `NULL` `GError*`.
  The argument will be left initialized to `NULL` by the function if there are no errors.
  In case of error, the argument will be set to a newly allocated `GError`; the caller will take ownership of the data, and be responsible for freeing it.

#### Return value

Type: `VteRegex`

A newly created `VteRegex`, or `NULL` with `error` filled in.

The caller of the function takes ownership of the data, and is responsible for freeing it.