RepositoryExtensions.Unshelve Method

Copies shelved changes into a workspace.

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

Syntax

'Declaration
<WebMethodAttribute> _
Public Function Unshelve ( _
    shelvesetName As String, _
    shelvesetOwner As String, _
    workspaceName As String, _
    workspaceOwner As String, _
    items As ItemSpec(), _
    <OutAttribute> ByRef failures As List(Of Failure), _
    <OutAttribute> ByRef getOperations As StreamingCollection(Of GetOperation), _
    propertyNameFilters As String() _
) As Shelveset

[WebMethodAttribute]
public Shelveset Unshelve(
    string shelvesetName,
    string shelvesetOwner,
    string workspaceName,
    string workspaceOwner,
    ItemSpec[] items,
    out List<Failure> failures,
    out StreamingCollection<GetOperation> getOperations,
    string[] propertyNameFilters
)

[WebMethodAttribute]
public:
Shelveset^ Unshelve(
    String^ shelvesetName, 
    String^ shelvesetOwner, 
    String^ workspaceName, 
    String^ workspaceOwner, 
    array<ItemSpec^>^ items, 
    [OutAttribute] List<Failure^>^% failures, 
    [OutAttribute] StreamingCollection<GetOperation^>^% getOperations, 
    array<String^>^ propertyNameFilters
)

[<WebMethodAttribute>]
member Unshelve : 
        shelvesetName:string * 
        shelvesetOwner:string * 
        workspaceName:string * 
        workspaceOwner:string * 
        items:ItemSpec[] * 
        failures:List<Failure> byref * 
        getOperations:StreamingCollection<GetOperation> byref * 
        propertyNameFilters:string[] -> Shelveset

public function Unshelve(
    shelvesetName : String, 
    shelvesetOwner : String, 
    workspaceName : String, 
    workspaceOwner : String, 
    items : ItemSpec[], 
    failures : List<Failure>, 
    getOperations : StreamingCollection<GetOperation>, 
    propertyNameFilters : String[]
) : Shelveset

Parameters

• 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).

• failures
  Type: System.Collections.Generic.List<Failure>%

  List of errors preventing the unshelve from occurring.

• getOperations
  Type: Microsoft.TeamFoundation.Framework.Server.StreamingCollection<GetOperation>%

• propertyNameFilters
  Type: array<System.String[]

  List of properties to return with get operations.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Server.Shelveset
GetOperations reflecting required changes to client state.

Remarks

Client call sequence: 1) Call Unshelve(). 2) For each GetOperation returned: a) Download the file by 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, all of the 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

RepositoryExtensions Class

Microsoft.TeamFoundation.VersionControl.Server Namespace