Share via

VCCLCompilerTool.PreprocessorDefinitions Property

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.VCProjectEngine
Assembly:
Microsoft.VisualStudio.VCProjectEngine.dll
Package:
Microsoft.VisualStudio.VCProjectEngine v17.11.40252

Gets or sets one or more preprocessor defines. PreprocessorDefinitions exposes the functionality of the compiler's /D (Preprocessor Definitions) option, the MIDL compiler's MIDL Property Pages: General option, and the Resource Compiler's Resources Property Pages option.

public:
 property System::String ^ PreprocessorDefinitions { System::String ^ get(); void set(System::String ^ value); };
public:
 property Platform::String ^ PreprocessorDefinitions { Platform::String ^ get(); void set(Platform::String ^ value); };
[System.Runtime.InteropServices.DispId(60)]
public string PreprocessorDefinitions { [System.Runtime.InteropServices.DispId(60)] get; [System.Runtime.InteropServices.DispId(60)] set; }
[<System.Runtime.InteropServices.DispId(60)>]
[<get: System.Runtime.InteropServices.DispId(60)>]
[<set: System.Runtime.InteropServices.DispId(60)>]
member this.PreprocessorDefinitions : string with get, set
Public Property PreprocessorDefinitions As String

Property Value

String

One or more preprocessor defines.

Attributes
DispIdAttribute

Examples

See How to: Compile Example Code for Project Model Extensibility for information about how to compile and run this example.

The following example modifies the compiler's PreprocessorDefinitions 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 VCCLCompilerTool  
        Dim oldDefs As String  
        prj = DTE.Solution.Projects.Item(1).Object  
        cfgs = prj.Configurations  
        cfg = cfgs.Item(1)  
        tool = cfg.Tools("VCCLCompilerTool")  
        oldDefs = tool.PreprocessorDefinitions  
        tool.PreprocessorDefinitions = "_TEST;" + oldDefs  
        MsgBox(tool.PreprocessorDefinitions)  
    End Sub  
End Module

Applies to