Unit 'sysutils' Package
[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] [#rtl]

FindCmdLineSwitch

Check whether a certain switch is present on the command-line.

Declaration

Source position: sysstrh.inc line 293

function FindCmdLineSwitch(

  const Switch: string;

  const Chars: TSysCharSet;

  IgnoreCase: Boolean

):Boolean;

function FindCmdLineSwitch(

  const Switch: string;

  IgnoreCase: Boolean

):Boolean;

function FindCmdLineSwitch(

  const Switch: string

):Boolean;

function FindCmdLineSwitch(

  const Switch: string;

  var Value: string;

  IgnoreCase: Boolean = True;

  const SwitchTypes: TCmdLineSwitchTypes = [clstValueNextParam, clstValueAppended]

):Boolean;

Description

FindCmdLineSwitch will check all command-line arguments for the presence of the option Switch. It will return True if it was found, False otherwise. Characters that appear in Chars (default is SwitchChars) are assumed to indicate an option (switch). If the parameter IgnoreCase is True, case will be ignored when looking for the switch. Default is to search case sensitive.

Errors

None.

See also

SwitchChars

  

Characters which start a command-line switch.


Documentation generated on: Dec 27 2024