Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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(), _
itemAttributeFilters As String() _
) As TeamFoundationDataReader
public TeamFoundationDataReader Unshelve(
TeamFoundationRequestContext requestContext,
string shelvesetName,
string shelvesetOwner,
string workspaceName,
string workspaceOwner,
ItemSpec[] items,
string[] itemAttributeFilters
)
public:
TeamFoundationDataReader^ Unshelve(
TeamFoundationRequestContext^ requestContext,
String^ shelvesetName,
String^ shelvesetOwner,
String^ workspaceName,
String^ workspaceOwner,
array<ItemSpec^>^ items,
array<String^>^ itemAttributeFilters
)
member Unshelve :
requestContext:TeamFoundationRequestContext *
shelvesetName:string *
shelvesetOwner:string *
workspaceName:string *
workspaceOwner:string *
items:ItemSpec[] *
itemAttributeFilters:string[] -> TeamFoundationDataReader
public function Unshelve(
requestContext : TeamFoundationRequestContext,
shelvesetName : String,
shelvesetOwner : String,
workspaceName : String,
workspaceOwner : String,
items : ItemSpec[],
itemAttributeFilters : String[]
) : TeamFoundationDataReader
Parameters
requestContext
Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationRequestContextThe request context.
shelvesetName
Type: System.StringName of shelveset to unshelve.
shelvesetOwner
Type: System.StringOwner of shelveset to unshelve.
workspaceName
Type: System.StringName of workspace to unshelve into.
workspaceOwner
Type: System.StringOwner of workspace to unshelve into.
items
Type: array<Microsoft.TeamFoundation.VersionControl.Server.ItemSpec[]ItemSpecs to unshelve (local, server, wildcard, recursion OK).
itemAttributeFilters
Type: array<System.String[]List of properties to return with get operations.
Return Value
Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationDataReader
TeamFoundationDataReader with results in the following order: Shelveset - The shelveset object that has all the meta-data. Failure[] - List of errors preventing the unshelve operation. GetOperation[] - 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, the whole 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.