Skip to main content

LeftStr

Function LeftStr(const AText: AnsiString; const ACount: Integer): AnsiString

Example

procedure ScriptEvent(var Value: variant);
begin
Value := LeftStr('ABCDEFGHIJ', 4); // ABCD
end;

Usage

LeftStr returns up to ACount leading units from an AnsiString.

Parameters and result

ItemTypeDescription
ATextAnsiStringSource text.
ACountIntegerMaximum leading units to return.
ResultAnsiStringLeading substring, full input if the count exceeds its length, or empty for a non-positive count.

Empty input returns empty. No trimming, case conversion or padding occurs. Oversized counts truncate safely to the available source.

Encoding boundary

In this build an ANSI string length and copy count are byte/code-unit based. If the active code page represents a character with multiple bytes, a boundary can split that encoding. Avoid arbitrary slicing of international text unless its encoding and valid boundaries are known.

MidStr performs the same ANSI-unit slicing from a caller-supplied start position.

Additional Technical Info

LeftStr returns the leading portion of AText, limited to ACount ANSI string units. It leaves the input unchanged and is equivalent in the installed terminal to Copy(AText, 1, ACount).

The example is fictional and source-reviewed only.

External references

Created 2026-07-15