VCFileConfiguration.ExcludedFromBuild Property

Definition

Namespace:: Microsoft.VisualStudio.VCProjectEngine

Assembly:: Microsoft.VisualStudio.VCProjectEngine.dll

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)]
[get: System.Runtime.InteropServices.DispId(501)]
[set: System.Runtime.InteropServices.DispId(501)]
public bool ExcludedFromBuild { get; set; }

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

Examples

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