System.SysUtils.FindCmdLineSwitch

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

function FindCmdLineSwitch(const Switch: string; const Chars: TSysCharSet; IgnoreCase: Boolean): Boolean;
function FindCmdLineSwitch(const Switch: string): Boolean;
function FindCmdLineSwitch(const Switch: string; IgnoreCase: Boolean): Boolean;
function FindCmdLineSwitch(const Switch: string; var Value: string; IgnoreCase: Boolean = True; const SwitchTypes: TCmdLineSwitchTypes = [clstValueNextParam, clstValueAppended]): Boolean; overload;

C++

extern DELPHI_PACKAGE bool __fastcall FindCmdLineSwitch(const System::UnicodeString Switch, const TSysCharSet &Chars, bool IgnoreCase)/* overload */;

プロパティ

種類 可視性 ソース ユニット
function public
System.SysUtils.pas
System.SysUtils.hpp
System.SysUtils System.SysUtils


説明

文字列がアプリケーションのコマンドライン引数として渡されたかどうかを判定します。


FindCmdLineSwitch は、文字列の最初の文字に基づいて、その文字列がコマンドライン スイッチを表しているかどうかを判定します。

  • Switch は、検索対象のコマンドライン パラメータです。
  • Chars は、スイッチとそれ以外のパラメータとを区別する文字の集合です。Switch を省略した場合、デフォルトは、Unix ベースのシステムでは '-' に、Windows ベースのシステムでは '/' および '-' になります。
  • IgnoreCase では、文字を比較する際に大文字と小文字の区別を無視するかどうかを指定します。デフォルトは True です。このオーバーロードでは、この関数を使ってコマンドライン スイッチを検索するほかに、パラメータ値を取得することもできます。
  • Value には、指定したスイッチに関連付けられた値が返されます。
  • SwitchTypes には、パラメータ値の解析方法を指定します。


定数

clstValueNextParam

-p <値>

clstValueAppended

-p <値> または -p:<値>


clstValueNextParam パラメータは、値とスイッチがスペース文字で区切られていることを示します。clstValueAppended パラメータは、スイッチ(スペースなし)またはコロンの直後に値が続くことを示します。SwitchTypes はセット型のパラメータであり、デフォルトではどちらの種類のパラメータの値も返されます([clstValueNextParam, clstValueAppended])。1 つのスイッチの種類を指定することもできます。SwitchTypes パラメータを空([])にすると、値は何も返されません。SwitchTypes パラメータを渡すと、これらのうち任意の種類のスイッチを除外することができます(Switch には 1 文字以上の長さの文字列を指定することができます)。

関連項目