ConsoleApplicationBase.CommandLineArgs プロパティ

.NET Framework クラス ライブラリ リファレンス

ConsoleApplicationBase.CommandLineArgs プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

現在のアプリケーションのコマンド ライン引数が文字列として格納されたコレクションを取得します。

名前空間: Microsoft.VisualBasic.ApplicationServices
アセンブリ: Microsoft.VisualBasic (microsoft.visualbasic.dll 内)
構文

Visual Basic (宣言)

Public ReadOnly Property
 CommandLineArgs As ReadOnlyCollection(Of
 String)

Visual Basic (使用法)

Dim instance As ConsoleApplicationBase
Dim value As ReadOnlyCollection(Of
 String)

value = instance.CommandLineArgs

C#

public ReadOnlyCollection<string> CommandLineArgs
 { get; }

C++

public:
property ReadOnlyCollection<String^>^ CommandLineArgs {
    ReadOnlyCollection<String^>^ get ();
}

J#

/** @property */
public ReadOnlyCollection<String> get_CommandLineArgs ()

JScript

public function get CommandLineArgs
 () : ReadOnlyCollection<String>

プロパティ値
現在のアプリケーションのコマンド ライン引数が文字列として格納された、String の ReadOnlyCollection。

解説

詳細については、Visual Basic のトピック「My.Application.CommandLineArgs プロパティ」を参照してください。

My.Application.CommandLineArgs プロパティは、現在のアプリケーションのコマンド ライン引数に対する読み取り専用アクセスを提供します。ただし、ClickOnce で配置されるアプリケーションには使用できません。

単一インスタンス アプリケーションの場合、My.Application.CommandLineArgs プロパティは、最初のインスタンスのコマンド ライン引数を返します。単一インスタンス アプリケーションに対して複数のインスタンスを生成し、2 番目以降のインスタンスの引数にアクセスするには、My.Application.StartupNextInstance イベント を処理して、StartupEventArgs 引数の CommandLine プロパティを調べる必要があります。

メモ
My.Application.CommandLineArgs プロパティは、コマンド ライン引数のみを返します。この点で、引数以外にアプリケーション名を返す CommandLine プロパティとは動作が異なります。

メモ
ClickOnce を使って配置されたアプリケーションの場合は、My.Application.Deployment オブジェクトの ActivationUri プロパティを使用してコマンド ライン引数を取得します。詳細については、「My.Application.Deployment プロパティ」を参照してください。

My.Application.CommandLineArgs プロパティを使ったタスクの例を次の表に示します。

目的	参照項目
アプリケーションの起動時に、引数として文字列 /batch が渡されたかどうかをチェックする。	方法 : Windows フォーム アプリケーションのバッチ モードを有効にする
単一インスタンス アプリケーションに対して複数のインスタンスを生成した場合のコマンド ライン引数をチェックする。	My.Application.StartupNextInstance イベント

使用例

この例では、My.Application.CommandLineArgs プロパティを使用して、アプリケーションのコマンド ライン引数を調べています。/input= で始まる引数が見つかった場合は、その引数の残りの部分が表示されます。

Visual Basic

Private Sub ParseCommandLineArgs()
    Dim inputArgument As String
 = "/input="
    Dim inputName As String
 = ""

    For Each s As String
 In My.Application.CommandLineArgs
        If s.ToLower.StartsWith(inputArgument) Then
            inputName = s.Remove(0, inputArgument.Length)
        End If
    Next

    If inputName = "" Then
        MsgBox("No input name")
    Else
        MsgBox("Input name: " & inputName)
    End If
End Sub

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ConsoleApplicationBase クラス
ConsoleApplicationBase メンバ
Microsoft.VisualBasic.ApplicationServices 名前空間
ReadOnlyCollection
ConsoleApplicationBase.CommandLineArgs プロパティ
StartupEventArgs
CommandLine
その他の技術情報
My.Application.CommandLineArgs プロパティ
My.Application オブジェクト
My.Application.StartupNextInstance イベント