VersionControlServer.GetWorkspace Method (String)

Article
2012-08-13

Gets the Workspace that is mapped to the specified local path.

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

Syntax

'Declaration
Public Function GetWorkspace ( _
    localPath As String _
) As Workspace

public Workspace GetWorkspace(
    string localPath
)

public:
Workspace^ GetWorkspace(
    String^ localPath
)

member GetWorkspace : 
        localPath:string -> Workspace

public function GetWorkspace(
    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.

Exceptions

Exception	Condition
ItemNotMappedException	Thrown if no Workspace is found associated with the specified WorkspaceInfo.

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. If no workspace is found, this method throws an ItemNotMappedException.

.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