ConsoleApplicationBase.CommandLineArgs Property
Gets a collection containing the command-line arguments as strings for the current application.
Assembly: Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)
Property Value
Type: System.Collections.ObjectModel.ReadOnlyCollection<String>A ReadOnlyCollection<T> of String, containing the command-line arguments as strings for the current application.
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 if the application started with the string /batch as an argument |
How to: Enable a Batch Mode for Window Forms Applications (Visual Basic) |
|
Check the command-line arguments of subsequent attempts to start a single-instance application |
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 |
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
-
EnvironmentPermission
Controls the ability to access the PATH environment variable. Associated enumeration: Read.
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Note