VCFilter.CanAddFile Method

Article
04/26/2013

Returns true if the specified file can be added to the current filter.

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

Syntax

'Declaration
Function CanAddFile ( _
    bstrFile As String _
) As Boolean

bool CanAddFile(
    string bstrFile
)

bool CanAddFile(
    [InAttribute] String^ bstrFile
)

abstract CanAddFile : 
        bstrFile:string -> bool

function CanAddFile(
    bstrFile : String
) : boolean

Parameters

bstrFile
Type: String

Required. The new file to be added. The full path must be unique in the project and valid. If you pass a relative path here, it is assumed to be relative to the project directory.

Return Value

Type: Boolean
true if the file can be added; otherwise, false.

Remarks

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

Examples

The following example uses CanAddFile 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)
        ret = filter.CanAddFile("somefile.cpp")
        MsgBox(ret)
    End Sub
End Module

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via