API Reference / String / strInstr

strInstr

Searches for a substring within a string. Takes str (string to search), substring (substring to find), start (1-based starting position). Returns the 1-based position of the first occurrence of substring within str, or 0 if not found.

String

Parameters & Returns

Parameters

str String
substring String
start Int

Returns

Int

Quick Summary

Searches for a substring within a string. Takes str (string to search), substring (substring to find), start (1-based starting position). Returns the 1-based position of the first occurrence of substring within str, or 0 if not found.

Technical Exegesis...

Returns the 1-based position of the first occurrence of substring within str, starting the search at position start. Returns 0 if the substring is not found.

Uses 1-based indexing: position 1 is the first character. If start is less than 1, search begins at position 1. If start is beyond the string length, returns 0. Returns 0 if substring is empty.

Example

Example.bam 
; No example implemented yet
Since: 1.0 Status: Stable
← Back to String