System.Low

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function Low(var X): Integer;

Properties

Type Visibility Source Unit Parent
function public System.pas System System

Description

Returns the lowest value in a range.

In Delphi code, call Low to obtain the lowest value or first element of an Ordinal, Array, or ShortString. The result type is X, or the index type of X, where X is either a type identifier or a variable reference.

Type Low returns

Ordinal type (includes Int64)

The lowest value in the range of the type.

Array type

The lowest value is within the range of the index type of the array.

short string type

Returns 0.

Note: Zero elements is the string length.

Open array

Returns 0.

AnsiString

Returns 1 when Zero Based Strings is off; otherwise, it returns 0.

WideString

Returns 1 when Zero Based Strings is off; otherwise, it returns 0.

UnicodeString

Returns 1 when Zero Based Strings is off; otherwise, it returns 0.

short string parameter (OpenString)

Returns 0.

Note: Zero elements is the string length.
Note: Low does not apply for array properties.

See Also

Code Examples