This documentation is archived and is not being maintained.

ITeamProjectCollectionServicing::QueueDetachCollection Method (Guid, IDictionary<String, String>, String, String%)

Queues the snapshot operation for the collection.

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

ServicingJobDetail^ QueueDetachCollection(
	Guid collectionId, 
	IDictionary<String^, String^>^ servicingTokens, 
	String^ collectionStoppedMessage, 
	[OutAttribute] String^% detachedConnectionString
)

Parameters

collectionId
Type: System::Guid

The id of the collection to snapshot.

servicingTokens
Type: System.Collections.Generic::IDictionary<String, String>

Replacement strings for tokens in collection creation servicing steps.

collectionStoppedMessage
Type: System::String

The message to show for requests that hit this collection since it will be taken offline if it isn't already.

detachedConnectionString
Type: System::String%

If true, the collection data will be prepared for attach and left attached to the current TFS Instance.

The connection string to the database of the detached collection.

Return Value

Type: Microsoft.TeamFoundation.Framework.Client::ServicingJobDetail
Returns the servicing job result which contains the job and host Id

Show: