Breaks the string on the pattern, and returns an array of the tokens. If the pattern contains capturing parentheses, then the text for each of the substrings will also be returned. If the pattern does not match anywhere in the string, then the whole string is returned as the first token.

As a special case, the result of splitting the empty string "" is an empty vector, not a vector containing a single string. The reason for this special case is that being able to represent an empty vector is typically more useful than consistent handling of empty elements. If you do need to represent empty elements, you'll need to check for the empty string before calling this function.

A pattern that can match empty strings splits string into separate characters wherever it matches the empty string between characters. For example splitting "ab c" using as a separator "\s*", you will get "a", "b" and "c".

Setting start_position differs from just passing over a shortened string and setting G_REGEX_MATCH_NOTBOL in the case of a pattern that begins with any kind of lookbehind assertion, such as "\b".

class Regex


string_ string

the string to split with the pattern

startPosition int

starting index of the string to match, in bytes

matchOptions GRegexMatchFlags

match time option flags

maxTokens int

the maximum number of tokens to split string into. If this is less than 1, the string is split completely

Return Value

Type: string[]

a NULL-terminated gchar ** array. Free it using g_strfreev()


GException on failure.