VCCustomBuildTool.CommandLine Property

Reference

Definition

Namespace:: Microsoft.VisualStudio.VCProjectEngine

Assembly:: Microsoft.VisualStudio.VCProjectEngine.dll

Package:: Microsoft.VisualStudio.VCProjectEngine v17.12.40390

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 or sets a command line for the build event tool to run.

public:
 property System::String ^ CommandLine { System::String ^ get(); void set(System::String ^ value); };

public:
 property Platform::String ^ CommandLine { Platform::String ^ get(); void set(Platform::String ^ value); };

[System.Runtime.InteropServices.DispId(1)]
public string CommandLine { [System.Runtime.InteropServices.DispId(1)] get; [System.Runtime.InteropServices.DispId(1)] set; }

[<System.Runtime.InteropServices.DispId(1)>]
[<get: System.Runtime.InteropServices.DispId(1)>]
[<set: System.Runtime.InteropServices.DispId(1)>]
member this.CommandLine : string with get, set

Public Property CommandLine As String

Property Value

String

A command line for the build event tool to run.

Attributes: DispIdAttribute

Examples

The following example modifies the VCPreBuildEventTool object's CommandLine property in the integrated development environment (IDE):

' add reference to Microsoft.VisualStudio.VCProjectEngine  
Imports EnvDTE  
Imports Microsoft.VisualStudio.VCProjectEngine  

Public Module Module1  
    Sub Test()  
        Dim prj As VCProject  
        Dim cfgs, tools As IVCCollection  
        Dim cfg As VCConfiguration  
        Dim tool As VCPostBuildEventTool  
        prj = DTE.Solution.Projects.Item(1).Object  
        cfgs = prj.Configurations  
        cfg = cfgs.Item(1)  
        tool = cfg.Tools("VCPreBuildEventTool")  
        tool.CommandLine = "your command"  
    End Sub  
End Module

Remarks

For more information, see Specifying Build Events. See How to: Compile Example Code for Project Model Extensibility for information on how to compile and run this example.

Applies to

Partager via