Share via

VCCLCompilerTool.ForcedIncludeFiles Property

  • Reference

Definition

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

Gets or sets a value that specifies one or more forced include files. ForcedIncludeFiles exposes the functionality of the compiler's /FI (Name Forced Include File) option.

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

Property Value

String

A string that specifies one or more forced include files.

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 ForcedIncludeFiles 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.ForcedIncludeFiles = "c:\a.h;d:\b.h"  
    End Sub  
End Module

Applies to