VCCLCompilerTool.PrecompiledHeaderFile Property

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.

Namespace: Microsoft.VisualStudio.VCProjectEngine
Assembly: Microsoft.VisualStudio.VCProjectEngine (in Microsoft.VisualStudio.VCProjectEngine.dll)

Syntax

'Declaration
Property PrecompiledHeaderFile As String
string PrecompiledHeaderFile { get; set; }
property String^ PrecompiledHeaderFile {
    String^ get ();
    void set (String^ value);
}
abstract PrecompiledHeaderFile : string with get, set
function get PrecompiledHeaderFile () : String 
function set PrecompiledHeaderFile (value : String)

Property Value

Type: System.String
The path and/or name of the generated precompiled header file.

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

.NET Framework Security

See Also

Reference

VCCLCompilerTool Interface

Microsoft.VisualStudio.VCProjectEngine Namespace