VCCLCompilerTool.PrecompiledHeaderFile Property

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.VCProjectEngine
Assembly:
Microsoft.VisualStudio.VCProjectEngine.dll

Gets or sets the path and/or name of the generated precompiled header file. PrecompiledHeaderFile exposes the functionality of the compiler's /Fp (Name .Pch File) option.

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

Property Value

String

The path and/or name of the generated precompiled header file.

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 PrecompiledHeaderFile 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  
        prj = DTE.Solution.Projects.Item(1).Object  
        cfgs = prj.Configurations  
        cfg = cfgs.Item(1)  
        tool = cfg.Tools("VCCLCompilerTool")  
        tool.PrecompiledHeaderFile = "MyFile.h"  
    End Sub  
End Module

Applies to