Workspace.GetLocalItemForServerItem Method (String, Boolean)

Gets the corresponding local item for the specified server item.

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

Syntax

'Declaration
Public Function GetLocalItemForServerItem ( _
    serverItem As String, _
    detectImplicitCloak As Boolean _
) As String
public string GetLocalItemForServerItem(
    string serverItem,
    bool detectImplicitCloak
)
public:
String^ GetLocalItemForServerItem(
    String^ serverItem, 
    bool detectImplicitCloak
)
member GetLocalItemForServerItem : 
        serverItem:string * 
        detectImplicitCloak:bool -> string
public function GetLocalItemForServerItem(
    serverItem : String, 
    detectImplicitCloak : boolean
) : String

Parameters

  • detectImplicitCloak
    Type: System.Boolean

    True to detect whether the server item is implicitly cloaked in the workspace. Forces this method to return false if the server item is implicitly cloaked. False to ignore implicit cloaking.

Return Value

Type: System.String
The corresponding local item for the specified server item.

Exceptions

Exception Condition
ItemNotMappedException

Thrown if the server item is not mapped in the workspace.

ItemCloakedException

Thrown if the server item is cloaked in the workspace.

Remarks

First shipped in TFS 2010

.NET Framework Security

See Also

Reference

Workspace Class

GetLocalItemForServerItem Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace