My.Application.CommandLineArgs プロパティ

[アーティクル]
08/16/2008

更新 : 2007 年 11 月

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

' Usage
Dim value As System.Collections.ObjectModel.ReadOnlyCollection(Of String) = My.Application.CommandLineArgs
' Declaration
Public ReadOnly Property CommandLineArgs As System.Collections.ObjectModel.ReadOnlyCollection(Of String)

戻り値

現在のアプリケーションのコマンドライン引数が文字列のコレクションとして格納される String の ReadOnlyCollection<T> です。

解説

My.Application.CommandLineArgs プロパティは、ClickOnce を使用しないアプリケーションのために、現在のアプリケーションのコマンドライン引数に読み取り専用でアクセスできるようにします。

単一インスタンスアプリケーションの場合、My.Application.CommandLineArgs プロパティは、アプリケーションの最初のインスタンスのコマンドライン引数を返します。それ以降に単一インスタンスアプリケーションを起動しようとして使用された引数にアクセスするには、My.Application.StartupNextInstance イベントを処理し、StartupEventArgs 引数の CommandLine プロパティを調べる必要があります。

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

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

処理手順

My.Application.CommandLineArgs プロパティに関連するタスクの例を次の表に示します。

タスク	参照項目
アプリケーションの起動時に /batch という文字列が引数として指定されたかどうかを確認する方法を説明します。	方法 : Windows フォームアプリケーションのバッチモードを有効にする
単一インスタンスアプリケーションの 2 回目以降の起動に使用されたコマンドライン引数をチェックする方法を説明します。	My.Application.StartupNextInstance イベント

使用例

次のコード例は、My.Application.CommandLineArgs プロパティを使用して、アプリケーションのコマンドライン引数を確認します。/input= で始まる引数がある場合は、その引数の後続部分を表示します。

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

必要条件

名前空間 : Microsoft.VisualBasic.ApplicationServices

クラス : ConsoleApplicationBase

アセンブリ : Visual Basic ランタイムライブラリ (Microsoft.VisualBasic.dll)

プロジェクトの種類別の可用性

プロジェクトの種類	使用
Windows アプリケーション	可
クラスライブラリ	不可
コンソールアプリケーション	可
Windows コントロールライブラリ	不可
Web コントロールライブラリ	不可
Windows サービス	可
Web サイト	不可