ITeamProjectCollectionServicing.QueueDetachCollection Method (TeamProjectCollection, IDictionary<String, String>, String, String%)

Queues the detach operation for the collection.

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

Syntax

'Declaration
Function QueueDetachCollection ( _
    teamProjectCollection As TeamProjectCollection, _
    servicingTokens As IDictionary(Of String, String), _
    collectionStoppedMessage As String, _
    <OutAttribute> ByRef detachedConnectionString As String _
) As ServicingJobDetail

ServicingJobDetail QueueDetachCollection(
    TeamProjectCollection teamProjectCollection,
    IDictionary<string, string> servicingTokens,
    string collectionStoppedMessage,
    out string detachedConnectionString
)

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

abstract QueueDetachCollection : 
        teamProjectCollection:TeamProjectCollection * 
        servicingTokens:IDictionary<string, string> * 
        collectionStoppedMessage:string * 
        detachedConnectionString:string byref -> ServicingJobDetail

function QueueDetachCollection(
    teamProjectCollection : TeamProjectCollection, 
    servicingTokens : IDictionary<String, String>, 
    collectionStoppedMessage : String, 
    detachedConnectionString : String
) : ServicingJobDetail

Parameters

• teamProjectCollection
  Type: Microsoft.TeamFoundation.Framework.Client.TeamProjectCollection

  The team project collection to detach.

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

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

• collectionStoppedMessage
  Type: System.String

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

• detachedConnectionString
  Type: System.String%

  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

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

See Also

Reference

ITeamProjectCollectionServicing Interface

QueueDetachCollection Overload

Microsoft.TeamFoundation.Framework.Client Namespace