VCCLCompilerTool.UsePrecompiledHeader Property

Gets or sets a value that enables the creation or use of a precompiled header during the build. UsePrecompiledHeader exposes the functionality of the compiler's /Yc (Create Precompiled Header File) and /Yu (Use Precompiled Header File) options.

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

Syntax

'Declaration
Property UsePrecompiledHeader As pchOption
pchOption UsePrecompiledHeader { get; set; }
property pchOption UsePrecompiledHeader {
    pchOption get ();
    void set (pchOption value);
}
abstract UsePrecompiledHeader : pchOption with get, set
function get UsePrecompiledHeader () : pchOption 
function set UsePrecompiledHeader (value : pchOption)

Property Value

Type: Microsoft.VisualStudio.VCProjectEngine.pchOption
A pchOption value.

Remarks

Use the pchOption enumeration to change the value of this property.

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 UsePrecompiledHeader 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.UsePrecompiledHeader = pchOption.pchGenerateAuto
    End Sub
End Module

.NET Framework Security

See Also

Reference

VCCLCompilerTool Interface

Microsoft.VisualStudio.VCProjectEngine Namespace