API Reference / String / strMid

strMid

Extracts a substring from the middle of a string. Takes str (string to extract from), start (1-based starting position), length (number of characters). Returns a substring starting at position start with the specified length.

String

Parameters & Returns

Parameters

str String
start Int
length Int

Returns

String

Quick Summary

Extracts a substring from the middle of a string. Takes str (string to extract from), start (1-based starting position), length (number of characters). Returns a substring starting at position start with the specified length.

Technical Exegesis...

Returns a substring starting at position start (1-based) with the specified length. If length is negative or would extend past the end, returns from start to the end of the string.

Uses 1-based indexing: position 1 is the first character. Returns an empty string if start is less than 1 or beyond the string length.

Example

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