[Overview][Constants][Types][Classes][Procedures and functions][Variables] Reference for unit 'System' (#rtl)

ParamStr

Return value of a command-line argument.

Declaration

Source position: systemh.inc line 604

function ParamStr(

  l: LongInt

):String;

Description

Paramstr returns the L-th command-line argument. L must be between 0 and Paramcount, these values included. The zeroth argument is the path and file name with which the program was started.

The command-line parameters will be truncated to a length of 255, even though the operating system may support bigger command-lines. The Objpas unit (used in objfpc or delphi mode) define versions of Paramstr which return the full-length command-line arguments.

When the complete command-line must be accessed, the argv pointer should be used to retrieve the real values of the command-line parameters.

For an example, see Paramcount.

Errors

None.

See also

Paramcount

  

Return number of command-line parameters passed to the program.