VersionControlServer.TryGetWorkspace Method

Gets the workspace that is mapped to the specified local path. Does not throw an exception.

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

Syntax

'Declaration
Public Function TryGetWorkspace ( _
    localPath As String _
) As Workspace
public Workspace TryGetWorkspace(
    string localPath
)
public:
Workspace^ TryGetWorkspace(
    String^ localPath
)
member TryGetWorkspace : 
        localPath:string -> Workspace
public function TryGetWorkspace(
    localPath : String
) : Workspace

Parameters

  • localPath
    Type: System.String

    The local path of the desired workspace.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Client.Workspace
The workspace object that is associated with the specified local path. Null if a workspace is not found.

Remarks

This method searches all known workspaces on the current computer to identify a workspace that has explicitly or implicitly mapped the provided local path.

.NET Framework Security

See Also

Reference

VersionControlServer Class

Microsoft.TeamFoundation.VersionControl.Client Namespace