This documentation is archived and is not being maintained.

VCFileConfiguration.ExcludedFromBuild Property

Gets or sets a value indicating whether this item is excluded from the build.

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

bool ExcludedFromBuild { get; set; }

Property Value

Type: System.Boolean
true if this item is excluded from the build; otherwise, false.

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

See Specifying Build Events for information on accessing ExcludedFromBuild for a build event from the IDE.

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.

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