Workspace.LocalToServerItem Method

Translates a local item to a server 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 LocalToServerItem ( _
    requestContext As TeamFoundationRequestContext, _
    localItem As String, _
    honorCloaks As Boolean _
) As String

public string LocalToServerItem(
    TeamFoundationRequestContext requestContext,
    string localItem,
    bool honorCloaks
)

public:
String^ LocalToServerItem(
    TeamFoundationRequestContext^ requestContext, 
    String^ localItem, 
    bool honorCloaks
)

member LocalToServerItem : 
        requestContext:TeamFoundationRequestContext * 
        localItem:string * 
        honorCloaks:bool -> string

public function LocalToServerItem(
    requestContext : TeamFoundationRequestContext, 
    localItem : String, 
    honorCloaks : boolean
) : String

Parameters

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

• localItem
  Type: System.String

  Local item to translate.

• honorCloaks
  Type: System.Boolean

  True to throw ItemCloakedException on cloaked items.

Return Value

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