Template:Str find/doc

From wikiNonStop
Revision as of 12:12, 24 August 2024 by Majestix (talk | contribs) (1 revision imported: initial setup)

Usage

{{Str find|text|sub_string}}

Returns the position of first appearance of sub_string in text.

  • The comparison is case sensitive.
  • Returns -1 if sub_string not found
  • Character position is 1 based (not 0 based as usual in calculations).
  • If sub_string is empty, this routine returns 1. This case will often have to be handled specially.

Examples

In the examples, the string to be searched is

Abcdefghijklm

:

  • A; 1
  • a; -1
  • def; 4
  • klm; 11
  • zyx; -1

Examples with empty parameters:

  • empty;klm; -1
  • empty;empty; 1

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Str find

A template to find the numeric position of first appearance of ''sub_string'' in ''text''

Template parameters

ParameterDescriptionTypeStatus
Text1

The text to search within

Stringrequired
Sub_string2

The string to be searched within the text

Stringrequired

See also