Share via


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)

Syntax

'Declaration
Function QueueDetachCollection ( _
    collectionId As Guid, _
    servicingTokens As IDictionary(Of String, String), _
    collectionStoppedMessage As String, _
    <OutAttribute> ByRef detachedConnectionString As String _
) As ServicingJobDetail
ServicingJobDetail QueueDetachCollection(
    Guid collectionId,
    IDictionary<string, string> servicingTokens,
    string collectionStoppedMessage,
    out string detachedConnectionString
)
ServicingJobDetail^ QueueDetachCollection(
    Guid collectionId, 
    IDictionary<String^, String^>^ servicingTokens, 
    String^ collectionStoppedMessage, 
    [OutAttribute] String^% detachedConnectionString
)
abstract QueueDetachCollection : 
        collectionId:Guid * 
        servicingTokens:IDictionary<string, string> * 
        collectionStoppedMessage:string * 
        detachedConnectionString:string byref -> ServicingJobDetail
function QueueDetachCollection(
    collectionId : Guid, 
    servicingTokens : IDictionary<String, String>, 
    collectionStoppedMessage : String, 
    detachedConnectionString : String
) : ServicingJobDetail

Parameters

  • collectionId
    Type: System.Guid

    The id of the collection to snapshot.

  • 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

.NET Framework Security

See Also

Reference

ITeamProjectCollectionServicing Interface

QueueDetachCollection Overload

Microsoft.TeamFoundation.Framework.Client Namespace