Share via


TeamProjectCollectionService.QueueDetachCollection Method

Queues the snapshot operation for the collection.

Namespace:  Microsoft.TeamFoundation.Server.Core
Assembly:  Microsoft.TeamFoundation.Server.Core (in Microsoft.TeamFoundation.Server.Core.dll)

Syntax

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

Parameters

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

    The connection string for the collection that is being detached.

Return Value

Type: Microsoft.TeamFoundation.Framework.Server.ServicingJobDetail
The hostId for the pending detach.

.NET Framework Security

See Also

Reference

TeamProjectCollectionService Class

Microsoft.TeamFoundation.Server.Core Namespace