VersionControlPath.GetFullPath Method (String, Boolean, PathLength)

Canonicalizes the specified items specification and return the string. This will do things like remove ..'s, convert \ to /, etc. It throws an InvalidPathException if the item is the empty string, contains invalid characters including an embedded dollar sign (wildcards are not considered illegal in this check), or is too long.

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

Syntax

'Declaration
Public Shared Function GetFullPath ( _
    item As String, _
    checkReservedCharacters As Boolean, _
    maxPathLength As PathLength _
) As String

public static string GetFullPath(
    string item,
    bool checkReservedCharacters,
    PathLength maxPathLength
)

public:
static String^ GetFullPath(
    String^ item, 
    bool checkReservedCharacters, 
    PathLength maxPathLength
)

static member GetFullPath : 
        item:string * 
        checkReservedCharacters:bool * 
        maxPathLength:PathLength -> string

public static function GetFullPath(
    item : String, 
    checkReservedCharacters : boolean, 
    maxPathLength : PathLength
) : String

Parameters

• item
  Type: System.String

  Item specification to canonicalize.

• checkReservedCharacters
  Type: System.Boolean

  The Boolean flag whether to validate version control reserved characters or not.

• maxPathLength
  Type: Microsoft.TeamFoundation.VersionControl.Common.PathLength

Return Value

Type: System.String
Canonical string form of the item.

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

See Also

Reference

VersionControlPath Class

GetFullPath Overload

Microsoft.TeamFoundation.VersionControl.Common Namespace