VCPlatform.IncludeDirectories Property

Reference

Definition

Namespace:: Microsoft.VisualStudio.VCProjectEngine

Assembly:: Microsoft.VisualStudio.VCProjectEngine.dll

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 path to use when searching for include files while building a Visual C++ project.

public:
 property System::String ^ IncludeDirectories { System::String ^ get(); void set(System::String ^ value); };

public:
 property Platform::String ^ IncludeDirectories { Platform::String ^ get(); void set(Platform::String ^ value); };

[System.Runtime.InteropServices.DispId(2501)]
public string IncludeDirectories { [System.Runtime.InteropServices.DispId(2501)] get; [System.Runtime.InteropServices.DispId(2501)] set; }

[<System.Runtime.InteropServices.DispId(2501)>]
[<get: System.Runtime.InteropServices.DispId(2501)>]
[<set: System.Runtime.InteropServices.DispId(2501)>]
member this.IncludeDirectories : string with get, set

Public Property IncludeDirectories As String

Property Value

String

A path to use when searching for include files while building a Visual C++ project. IncludeDirectories corresponds to the environment variable, INCLUDE.

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 IncludeDirectories 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 p As VCPlatform  
        Dim x As String  
        prj = DTE.Solution.Projects.Item(1).Object  
        p = prj.Platforms(1)  
        x = p.IncludeDirectories  
        p.IncludeDirectories = x + ";something"  
        MsgBox(p.IncludeDirectories)  
    End Sub  
End Module

Remarks

By default in Visual C++ 2010, this property does not inherit from parent or project defaults. To inherit defaults when you set an include files path, append the project $(IncludePath) macro to the path. For an example of inheriting project defaults for a property similar to this one, see the remarks and example for ExcludeDirectories.

Applies to