Поделиться через

Add command-line switches

  • Статья

Applies to: yesVisual Studio noVisual Studio for Mac

Note

This article applies to Visual Studio 2017. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

You can add command-line switches that apply to your VSPackage when devenv.exe is executed. Use ProvideAppCommandLineAttribute to declare the name of the switch and its properties. In this example, the MySwitch switch is added for a subclass of VSPackage named AddCommandSwitchPackage with no arguments and with the VSPackage loaded automatically.

[ProvideAppCommandLine("MySwitch", typeof(AddCommandSwitchPackage), Arguments = "0", DemandLoad = 1)]

The named parameters are shown in the following descriptions.

Name Description
Arguments The number of arguments for the switch. Can be "*", or a list of arguments.
DemandLoad Load the VSPackage automatically if this is set to 1, otherwise set to 0.
HelpString The help string or resource ID of the string to display with devenv /?.
Name The switch.
PackageGuid The GUID of the package.

The first value of Arguments is usually 0 or 1. A special value of '*' can be used to indicate that the entire remainder of the command line is the argument. This can be useful for debugging scenarios where a user must pass in a debugger command string.

The DemandLoad value is either true (1) or false (0) indicates that the VSPackage should be loaded automatically.

The HelpString value is the resource ID of the string that appears in the devenv /? Help display. This value should be in the form "#nnn" where nnn is an integer. The string value in the resource file should end in a new line character.

The Name value is the name of the switch.

The PackageGuid value is the GUID of the package that implements this switch. The IDE uses this GUID to find the VSPackage in the registry to which the command-line switch applies.

Retrieve command-line switches

When your package is loaded, you can retrieve the command-line switches by completing the following steps.

  1. In your VSPackage's SetSite implementation, call QueryService on SVsAppCommandLine to get the IVsAppCommandLine interface.

  2. Call GetOption to retrieve the command-line switches that the user entered.

    The following code shows how to find out whether the MySwitch command-line switch was entered by the user:

IVsAppCommandLine cmdline = (IVsAppCommandLine)GetService(typeof(SVsAppCommandLine));

int isPresent = 0;
string optionValue = "";

cmdline.GetOption("MySwitch", out isPresent, out optionValue);

It is your responsibility to check for your command-line switches each time your package is loaded.

See also