TeamFoundationVersionControlService.Unshelve Method (TeamFoundationRequestContext, String, String, String, String, array<ItemSpec[], array<String[], array<String[], array<String , Boolean, PathLength)

Copies shelved changes into a workspace.

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

Syntax

'Declaration
Public Function Unshelve ( _
    requestContext As TeamFoundationRequestContext, _
    shelvesetName As String, _
    shelvesetOwner As String, _
    workspaceName As String, _
    workspaceOwner As String, _
    items As ItemSpec(), _
    itemPropertyFilters As String(), _
    itemAttributeFilters As String(), _
    shelvesetPropertyNameFilters As String(), _
    merge As Boolean, _
    maxClientPathLength As PathLength _
) As TeamFoundationDataReader

public TeamFoundationDataReader Unshelve(
    TeamFoundationRequestContext requestContext,
    string shelvesetName,
    string shelvesetOwner,
    string workspaceName,
    string workspaceOwner,
    ItemSpec[] items,
    string[] itemPropertyFilters,
    string[] itemAttributeFilters,
    string[] shelvesetPropertyNameFilters,
    bool merge,
    PathLength maxClientPathLength
)

public:
TeamFoundationDataReader^ Unshelve(
    TeamFoundationRequestContext^ requestContext, 
    String^ shelvesetName, 
    String^ shelvesetOwner, 
    String^ workspaceName, 
    String^ workspaceOwner, 
    array<ItemSpec^>^ items, 
    array<String^>^ itemPropertyFilters, 
    array<String^>^ itemAttributeFilters, 
    array<String^>^ shelvesetPropertyNameFilters, 
    bool merge, 
    PathLength maxClientPathLength
)

member Unshelve : 
        requestContext:TeamFoundationRequestContext * 
        shelvesetName:string * 
        shelvesetOwner:string * 
        workspaceName:string * 
        workspaceOwner:string * 
        items:ItemSpec[] * 
        itemPropertyFilters:string[] * 
        itemAttributeFilters:string[] * 
        shelvesetPropertyNameFilters:string[] * 
        merge:bool * 
        maxClientPathLength:PathLength -> TeamFoundationDataReader

public function Unshelve(
    requestContext : TeamFoundationRequestContext, 
    shelvesetName : String, 
    shelvesetOwner : String, 
    workspaceName : String, 
    workspaceOwner : String, 
    items : ItemSpec[], 
    itemPropertyFilters : String[], 
    itemAttributeFilters : String[], 
    shelvesetPropertyNameFilters : String[], 
    merge : boolean, 
    maxClientPathLength : PathLength
) : TeamFoundationDataReader

Parameters

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

  The request context.

• shelvesetName
  Type: System.String

  Name of shelveset to unshelve.

• shelvesetOwner
  Type: System.String

  Owner of shelveset to unshelve.

• workspaceName
  Type: System.String

  Name of workspace to unshelve into.

• workspaceOwner
  Type: System.String

  Owner of workspace to unshelve into.

• items
  Type: array<Microsoft.TeamFoundation.VersionControl.Server.ItemSpec[]

  ItemSpecs to unshelve (local, server, wildcard, recursion OK.)

• itemPropertyFilters
  Type: array<System.String[]

• itemAttributeFilters
  Type: array<System.String[]

  List of properties to return with get operations.

• shelvesetPropertyNameFilters
  Type: array<System.String[]

  A list of shelveset properties to return with the shelveset object.

• merge
  Type: System.Boolean

• maxClientPathLength
  Type: Microsoft.TeamFoundation.VersionControl.Common.PathLength

  The maximum client supported server path length.

Return Value

Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationDataReader
TeamFoundationDataReader with results in the following order: Shelveset - The shelveset object with all the meta-data Failure[] - List of errors preventing the unshelve from occurring GetOperation[] - GetOperations reflecting required changes to client state.

Remarks

Client call sequence: 1) Call Unshelve() 2) For each GetOperation returned: a) Download the file using application/item.asmx?pcid=X where X is the pending change id b) Call UpdateLocalVersion, passing in local information and the pending change id If step 2 is interrupted, a future call to Get() will return the unconfirmed entries The shelveset will remain intact after this call, but may be immediately deleted even before step 2) is completed. If any Failures are returned, the entire operation will fail.

.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

TeamFoundationVersionControlService Class

Unshelve Overload

Microsoft.TeamFoundation.VersionControl.Server Namespace