VCFileConfigurationProperties.ExcludedFromBuild Property

Reference

Definition

Namespace:: Microsoft.VisualStudio.VCProject

Assembly:: Microsoft.VisualStudio.VCProject.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 value indicating whether this item is excluded from the build.

public:
 property bool ExcludedFromBuild { bool get(); void set(bool value); };

public:
 property bool ExcludedFromBuild { bool get(); void set(bool value); };

[System.Runtime.InteropServices.DispId(501)]
public bool ExcludedFromBuild { [System.Runtime.InteropServices.DispId(501)] get; [System.Runtime.InteropServices.DispId(501)] set; }

[<System.Runtime.InteropServices.DispId(501)>]
[<get: System.Runtime.InteropServices.DispId(501)>]
[<set: System.Runtime.InteropServices.DispId(501)>]
member this.ExcludedFromBuild : bool with get, set

Public Property ExcludedFromBuild As Boolean

Property Value

Boolean

true if this item is excluded from the build; otherwise, false.

Attributes: DispIdAttribute

Examples

[Visual Basic]

The following example code modifies the VCPreLinkEventTool object's ExcludedFromBuild property in the development environment:

' 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 VCPostBuildEventTool  
        prj = DTE.Solution.Projects.Item(1).Object  
        cfgs = prj.Configurations  
        cfg = cfgs.Item(1)  
        tool = cfg.Tools("VCPreLinkEventTool")  
        tool.ExcludedFromBuild = False  
    End Sub  
End Module

The following example shows how to use ExcludedFromBuild on a VCFileConfiguration object.

' add reference to Microsoft.VisualStudio.VCProjectEngine  
Imports EnvDTE  
Imports Microsoft.VisualStudio.VCProjectEngine  

Public Module Module1  
    Sub Test()  
        Dim file As VCFile  
        Dim col As IVCCollection  
        Dim fileconfig As VCFileConfiguration  
        Dim prj As VCProject  
        prj = DTE.Solution.Projects.Item(1).Object  
        col = prj.Files  
        file = col.Item("project6.cpp")  
        col = file.FileConfigurations  
        fileconfig = col.Item(1)  
        fileconfig.ExcludedFromBuild = True  
    End Sub  
End Module

Remarks

See General Property Page (File) for information about accessing ExcludedFromBuild for a file from the development environment.

See Specifying Build Events for information about accessing ExcludedFromBuild for a build event from the development environment.

ExcludedFromBuild specifies whether or not deployment occurs when the project is built. Set to true to disable deployment or set to false to enable deployment. See How to: Compile Example Code for Project Model Extensibility for information about how to compile and run this example.

Applies to

Share via