VCPlatform.MatchName Method

Article
10/10/2013

Matches a specified name to the name of a collection item.

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

Syntax

'Declaration
Function MatchName ( _
    NameToMatch As String, _
    FullOnly As Boolean _
) As Boolean

bool MatchName(
    string NameToMatch,
    bool FullOnly
)

bool MatchName(
    [InAttribute] String^ NameToMatch, 
    [InAttribute] bool FullOnly
)

abstract MatchName : 
        NameToMatch:string * 
        FullOnly:bool -> bool

function MatchName(
    NameToMatch : String, 
    FullOnly : boolean
) : boolean

Parameters

NameToMatch
Type: System.String

Required. The name to match.

FullOnly
Type: System.Boolean

Required. true if you want MatchName to match the full name of the string. false if you want to allow a match on the short name of the string.

Setting MatchName to true is useful for projects, folders, and files, and requires an absolute path to match. A folder's absolute path is the concatenation of the folder names above it, with its own name. A top-level folder's full name is the same as its name. If a folder named Source Files contains a subfolder named MyProject, the MyProject folder full name would be Source Files\MyProject.

Return Value

Type: System.Boolean
true if the name was matched; false otherwise.

Remarks

MatchName is a method that operates on a collection item. If you are iterating over the members of a collection, you can use the MatchName method to determine whether the current item is the one in which you are interested.

You can also use MatchName to match debug configurations, regardless of the platform (which is part of the full name Debug\Win32).

You cannot use MatchName for indexing into a collection. Indexing implies using the [] operator or its equivalent .Item() method, and MatchName does not affect either process.

Examples

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

The following example modifies the VCPlatformMatchName method in the integrated development environment (IDE):

' 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 p As VCPlatform
        prj = DTE.Solution.Projects.Item(1).Object
        p = prj.Platforms(1)

        If p.MatchName("Win32", True) Then
            p.ExecutableDirectories = "T"
        End If

    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.

Partager via