ConsoleApplicationBase.CommandLineArgs Property

Reference

Definition

Namespace:: Microsoft.VisualBasic.ApplicationServices

Assembly:: Microsoft.VisualBasic.dll

Assembly:: Microsoft.VisualBasic.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets a collection containing the command-line arguments as strings for the current application.

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

public System.Collections.ObjectModel.ReadOnlyCollection<string> CommandLineArgs { get; }

member this.CommandLineArgs : System.Collections.ObjectModel.ReadOnlyCollection<string>

Public ReadOnly Property CommandLineArgs As ReadOnlyCollection(Of String)

Property Value

ReadOnlyCollection<String>

A ReadOnlyCollection<T> of String, containing the command-line arguments as strings for the current application.

Examples

This example uses the My.Application.CommandLineArgs property to examine the application's command-line arguments. If an argument is found that starts with /input=, the rest of that argument is displayed.

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

Remarks

The My.Application.CommandLineArgs property provides read-only access to the current application's command-line arguments for applications that are not ClickOnce deployed.

For a single-instance application, the My.Application.CommandLineArgs property returns the command-line arguments for the first instance of an application. To access the arguments for subsequent attempts to start a single-instance application, you must handle the StartupNextInstance event and examine the CommandLine property of the StartupEventArgs argument.

Note

The My.Application.CommandLineArgs property returns only the command-line arguments. This is different from the behavior of the CommandLine property, which returns the application name in addition to the arguments.

Note

In an application that is ClickOnce deployed, use the ActivationUri property of the My.Application.Deployment object to get the command-line arguments. For more information, see Deployment.

The following table lists examples of tasks involving the My.Application.CommandLineArgs property.

To	See
Check the command-line arguments of subsequent attempts to start a single-instance application	StartupNextInstance

Availability by Project Type

Project type	Available
Windows Application	Yes
Class Library	No
Console Application	Yes
Windows Control Library	No
Web Control Library	No
Windows Service	Yes
Web Site	No

Applies to