API Reference / String / strRemove

strRemove

Removes a specified number of characters from a string. Takes str (original string), position (1-based starting position), count (number of characters to remove). Returns a new string with count characters removed starting at position.

String

Parameters & Returns

Parameters

str String
position Int
count Int

Returns

String

Quick Summary

Removes a specified number of characters from a string. Takes str (original string), position (1-based starting position), count (number of characters to remove). Returns a new string with count characters removed starting at position.

Technical Exegesis...

Returns a new string with count characters removed starting at position. Uses 1-based indexing: position 1 is the first character.

Returns the original string unchanged if position is invalid (< 1 or >= string length) or count is <= 0. If count extends beyond the string end, removes characters from position to the end. Useful for deleting substrings or trimming specific sections.

Example

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