Workspace.ServerToLocalItem Method

Translates a server item to a localitem item based on the workspace's working folders.

If honorCloaks is true, a cloaked item will give you an ItemCloakedException.

If honorCloaks is false, a cloaked item will return null.

An unmapped item will always give you an ItemNotMappedException.

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

Syntax

'Declaration
Public Function ServerToLocalItem ( _
    requestContext As TeamFoundationRequestContext, _
    serverItem As String, _
    honorCloaks As Boolean _
) As String

public string ServerToLocalItem(
    TeamFoundationRequestContext requestContext,
    string serverItem,
    bool honorCloaks
)

public:
String^ ServerToLocalItem(
    TeamFoundationRequestContext^ requestContext, 
    String^ serverItem, 
    bool honorCloaks
)

member ServerToLocalItem : 
        requestContext:TeamFoundationRequestContext * 
        serverItem:string * 
        honorCloaks:bool -> string

public function ServerToLocalItem(
    requestContext : TeamFoundationRequestContext, 
    serverItem : String, 
    honorCloaks : boolean
) : String

Parameters

• requestContext
  Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationRequestContext

• serverItem
  Type: System.String

  Server item to translate.

• honorCloaks
  Type: System.Boolean

  True to throw ItemCloakedException on cloaked items.

Return Value

Type: System.String
Corresponding local item for server 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

Workspace Class

Microsoft.TeamFoundation.VersionControl.Server Namespace