VCFilter.CanAddFilter(String) Method

Definition

Namespace:

Microsoft.VisualStudio.VCProjectEngine

Assembly:

Microsoft.VisualStudio.VCProjectEngine.dll

Package:

Microsoft.VisualStudio.VCProjectEngine v17.12.40390

Returns true if the specified filter can be added as a top-level filter or as a subfilter to the current filter.

public:
 bool CanAddFilter(System::String ^ Filter);

public:
 bool CanAddFilter(Platform::String ^ Filter);

bool CanAddFilter(std::wstring const & Filter);

[System.Runtime.InteropServices.DispId(2346)]
public bool CanAddFilter (string Filter);

[<System.Runtime.InteropServices.DispId(2346)>]
abstract member CanAddFilter : string -> bool

Public Function CanAddFilter (Filter As String) As Boolean

Parameters

Filter

String

Required. The new filter to be added. The filter name must be unique within the current scope and valid.

Returns

Boolean

true if the filter can be added; otherwise false.

Attributes

DispIdAttribute

Examples

The following example uses CanAddFilter in the integrated development environment (IDE):

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

Public Module Module1  
    Sub Test()  
        Dim mycollection As IVCCollection  
        Dim filter As VCFilter  
        Dim prj As VCProject  
        Dim ret As Boolean  
        prj = DTE.Solution.Projects.Item(1).Object  
        mycollection = prj.Filters  
        'mycollection.Count has count of files  
        filter = mycollection.Item(1)  
        MsgBox(filter.ItemName)  
        ret = filter.CanAddFilter("somename")  
        MsgBox(ret)  
    End Sub  
End Module  

Remarks

See How to: Compile Example Code for Project Model Extensibility for information about how to compile and run this example.