Share via


Repository4.Unshelve Method

Merges 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(), _
    itemPropertyFilters As String(), _
    itemAttrbuteFilters As String(), _
    shelvesetPropertyNameFilters As String(), _
    merge As Boolean, _
    <OutAttribute> ByRef failures As List(Of Failure), _
    <OutAttribute> ByRef getOperations As StreamingCollection(Of GetOperation), _
    <OutAttribute> ByRef conflicts As StreamingCollection(Of Conflict), _
    <OutAttribute> ByRef changePendedFlags As Integer _
) As Shelveset
[WebMethodAttribute]
public Shelveset Unshelve(
    string shelvesetName,
    string shelvesetOwner,
    string workspaceName,
    string workspaceOwner,
    ItemSpec[] items,
    string[] itemPropertyFilters,
    string[] itemAttrbuteFilters,
    string[] shelvesetPropertyNameFilters,
    bool merge,
    out List<Failure> failures,
    out StreamingCollection<GetOperation> getOperations,
    out StreamingCollection<Conflict> conflicts,
    out int changePendedFlags
)
[WebMethodAttribute]
public:
Shelveset^ Unshelve(
    String^ shelvesetName, 
    String^ shelvesetOwner, 
    String^ workspaceName, 
    String^ workspaceOwner, 
    array<ItemSpec^>^ items, 
    array<String^>^ itemPropertyFilters, 
    array<String^>^ itemAttrbuteFilters, 
    array<String^>^ shelvesetPropertyNameFilters, 
    bool merge, 
    [OutAttribute] List<Failure^>^% failures, 
    [OutAttribute] StreamingCollection<GetOperation^>^% getOperations, 
    [OutAttribute] StreamingCollection<Conflict^>^% conflicts, 
    [OutAttribute] int% changePendedFlags
)
[<WebMethodAttribute>]
member Unshelve : 
        shelvesetName:string * 
        shelvesetOwner:string * 
        workspaceName:string * 
        workspaceOwner:string * 
        items:ItemSpec[] * 
        itemPropertyFilters:string[] * 
        itemAttrbuteFilters:string[] * 
        shelvesetPropertyNameFilters:string[] * 
        merge:bool * 
        failures:List<Failure> byref * 
        getOperations:StreamingCollection<GetOperation> byref * 
        conflicts:StreamingCollection<Conflict> byref * 
        changePendedFlags:int byref -> Shelveset
public function Unshelve(
    shelvesetName : String, 
    shelvesetOwner : String, 
    workspaceName : String, 
    workspaceOwner : String, 
    items : ItemSpec[], 
    itemPropertyFilters : String[], 
    itemAttrbuteFilters : String[], 
    shelvesetPropertyNameFilters : String[], 
    merge : boolean, 
    failures : List<Failure>, 
    getOperations : StreamingCollection<GetOperation>, 
    conflicts : StreamingCollection<Conflict>, 
    changePendedFlags : int
) : 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.

  • itemAttrbuteFilters
    Type: array<System.String[]

    A list of versioned item properties to return with each get operation.

  • shelvesetPropertyNameFilters
    Type: array<System.String[]

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

  • merge
    Type: System.Boolean

    True if "merge" should be performed when unshelving. This will file merge and version conflicts for items that have conflicting pending changes and different pended versions respectively.

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.

.NET Framework Security

See Also

Reference

Repository4 Class

Microsoft.TeamFoundation.VersionControl.Server Namespace