Workspace.Unshelve Method (String, String, array<ItemSpec[], array<String[], array<String[], array<String[], Boolean, Boolean, array<PendingChange[]%, array<Conflict %)

Reproduces in this workspace a set of pending changes that have been previously shelved to the server.

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

Syntax

'Declaration
Public Function Unshelve ( _
    shelvesetName As String, _
    shelvesetOwner As String, _
    items As ItemSpec(), _
    itemAttributeFilters As String(), _
    itemPropertyFilters As String(), _
    shelvesetPropertyNameFilters As String(), _
    merge As Boolean, _
    noAutoResolve As Boolean, _
    <OutAttribute> ByRef changes As PendingChange(), _
    <OutAttribute> ByRef conflicts As Conflict() _
) As Shelveset
public Shelveset Unshelve(
    string shelvesetName,
    string shelvesetOwner,
    ItemSpec[] items,
    string[] itemAttributeFilters,
    string[] itemPropertyFilters,
    string[] shelvesetPropertyNameFilters,
    bool merge,
    bool noAutoResolve,
    out PendingChange[] changes,
    out Conflict[] conflicts
)
public:
Shelveset^ Unshelve(
    String^ shelvesetName, 
    String^ shelvesetOwner, 
    array<ItemSpec^>^ items, 
    array<String^>^ itemAttributeFilters, 
    array<String^>^ itemPropertyFilters, 
    array<String^>^ shelvesetPropertyNameFilters, 
    bool merge, 
    bool noAutoResolve, 
    [OutAttribute] array<PendingChange^>^% changes, 
    [OutAttribute] array<Conflict^>^% conflicts
)
member Unshelve : 
        shelvesetName:string * 
        shelvesetOwner:string * 
        items:ItemSpec[] * 
        itemAttributeFilters:string[] * 
        itemPropertyFilters:string[] * 
        shelvesetPropertyNameFilters:string[] * 
        merge:bool * 
        noAutoResolve:bool * 
        changes:PendingChange[] byref * 
        conflicts:Conflict[] byref -> Shelveset
public function Unshelve(
    shelvesetName : String, 
    shelvesetOwner : String, 
    items : ItemSpec[], 
    itemAttributeFilters : String[], 
    itemPropertyFilters : String[], 
    shelvesetPropertyNameFilters : String[], 
    merge : boolean, 
    noAutoResolve : boolean, 
    changes : PendingChange[], 
    conflicts : Conflict[]
) : Shelveset

Parameters

  • shelvesetName
    Type: System.String

    The name of the shelveset to unshelve

  • shelvesetOwner
    Type: System.String

    The name of the user who created the shelveset

  • itemAttributeFilters
    Type: array<System.String[]

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

  • itemPropertyFilters
    Type: array<System.String[]

    List of property filters.

  • shelvesetPropertyNameFilters
    Type: array<System.String[]

    The list of properties to be returned on the shelvesets. To get all properties pass a single filter that is just "*".

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

  • noAutoResolve
    Type: System.Boolean

    Prevents any conflicts from being auto resolved even if the option is set in the registry.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Client.Shelveset
The shelveset that was unshelved

.NET Framework Security

See Also

Reference

Workspace Class

Unshelve Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace