Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

VCCLCompilerTool.UsePrecompiledHeader Property

Definition

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

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 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.

public:
 property Microsoft::VisualStudio::VCProjectEngine::pchOption UsePrecompiledHeader { Microsoft::VisualStudio::VCProjectEngine::pchOption get(); void set(Microsoft::VisualStudio::VCProjectEngine::pchOption value); };
public:
 property Microsoft::VisualStudio::VCProjectEngine::pchOption UsePrecompiledHeader { Microsoft::VisualStudio::VCProjectEngine::pchOption get(); void set(Microsoft::VisualStudio::VCProjectEngine::pchOption value); };
[System.Runtime.InteropServices.DispId(161)]
public Microsoft.VisualStudio.VCProjectEngine.pchOption UsePrecompiledHeader { [System.Runtime.InteropServices.DispId(161)] get; [System.Runtime.InteropServices.DispId(161)] set; }
[<System.Runtime.InteropServices.DispId(161)>]
[<get: System.Runtime.InteropServices.DispId(161)>]
[<set: System.Runtime.InteropServices.DispId(161)>]
member this.UsePrecompiledHeader : Microsoft.VisualStudio.VCProjectEngine.pchOption with get, set
Public Property UsePrecompiledHeader As pchOption

Property Value

A pchOption value.

Attributes

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

Remarks

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

Applies to