Function: string-match

string-match is a function defined in search.c.

Signature

(string-match REGEXP STRING &optional START INHIBIT-MODIFY)

Documentation

Return index of start of first match for REGEXP in STRING, or nil.

Matching ignores case if case-fold-search is non-nil. If third arg START is non-nil, start search at that index in STRING.

If INHIBIT-MODIFY is non-nil, match data is not changed.

If INHIBIT-MODIFY is nil or missing, match data is changed, and match-end and match-beginning give indices of substrings matched by parenthesis constructs in the pattern. You can use the function match-string to extract the substrings matched by the parenthesis constructions in REGEXP. For index of first char beyond the match, do
(match-end 0).

View in manual

Probably introduced at or before Emacs version 17.

Source Code

// Defined in /usr/src/emacs/src/search.c
{
  return string_match_1 (regexp, string, start, 0, NILP (inhibit_modify));
}