Share via


BuildPath.IsValidPath Method

Validates a build item path and canonicalizes it if it is valid. The output value error is set when the path is not valid.

Namespace:  Microsoft.TeamFoundation.Build.Common
Assembly:  Microsoft.TeamFoundation.Build.Common (in Microsoft.TeamFoundation.Build.Common.dll)

Syntax

'Declaration
Public Shared Function IsValidPath ( _
    ByRef path As String, _
    allowWildcards As Boolean, _
    <OutAttribute> ByRef error As String _
) As Boolean
public static bool IsValidPath(
    ref string path,
    bool allowWildcards,
    out string error
)
public:
static bool IsValidPath(
    String^% path, 
    bool allowWildcards, 
    [OutAttribute] String^% error
)
static member IsValidPath : 
        path:string byref * 
        allowWildcards:bool * 
        error:string byref -> bool
public static function IsValidPath(
    path : String, 
    allowWildcards : boolean, 
    error : String
) : boolean

Parameters

  • allowWildcards
    Type: System.Boolean

    Whether or not wildcard characters should be allowed.

  • error
    Type: System.String%

    The error, if any, that caused the method to fail.

Return Value

Type: System.Boolean
True if the path is valid, false otherwise.

.NET Framework Security

See Also

Reference

BuildPath Class

Microsoft.TeamFoundation.Build.Common Namespace