Sign in Join
FPDoc Onlineexperiment

MidStr function

In unit StrUtils

Copies a number of characters starting at a given position in a string.

Declaration

pascal
function MidStr(const AText: AnsiString; const AStart: SizeInt; 
 const ACount: SizeInt): AnsiString

Arguments

AText

String to copy characters from.

AStart

Position (in characters) to start copying from.

ACount

Number of characters to copy.

Function result

Resulting string.

Description

MidStr returns a string containing the first ACount bytes from the string AText starting at position AStart. If AStart+ACount is larger than the length (in characters) of AText, only as many characters as available are returned. If AStart is less than 1 or larger than the length of AText, then no characters are returned.

This function is equivalent to the standard Copy function, and is provided for completeness only.

Errors

None.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.