TeamFoundationVersionControlService.Destroy Method (TeamFoundationRequestContext, ItemSpec, VersionSpec, VersionSpec, Int32, PathLength)

Destroy the subtree represented by itemSpec.

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

Syntax

'Declaration
Public Function Destroy ( _
    requestContext As TeamFoundationRequestContext, _
    item As ItemSpec, _
    versionSpec As VersionSpec, _
    stopAtSpec As VersionSpec, _
    flags As Integer, _
    maxClientPathLength As PathLength _
) As TeamFoundationDataReader

public TeamFoundationDataReader Destroy(
    TeamFoundationRequestContext requestContext,
    ItemSpec item,
    VersionSpec versionSpec,
    VersionSpec stopAtSpec,
    int flags,
    PathLength maxClientPathLength
)

public:
TeamFoundationDataReader^ Destroy(
    TeamFoundationRequestContext^ requestContext, 
    ItemSpec^ item, 
    VersionSpec^ versionSpec, 
    VersionSpec^ stopAtSpec, 
    int flags, 
    PathLength maxClientPathLength
)

member Destroy : 
        requestContext:TeamFoundationRequestContext * 
        item:ItemSpec * 
        versionSpec:VersionSpec * 
        stopAtSpec:VersionSpec * 
        flags:int * 
        maxClientPathLength:PathLength -> TeamFoundationDataReader

public function Destroy(
    requestContext : TeamFoundationRequestContext, 
    item : ItemSpec, 
    versionSpec : VersionSpec, 
    stopAtSpec : VersionSpec, 
    flags : int, 
    maxClientPathLength : PathLength
) : TeamFoundationDataReader

Parameters

• requestContext
  Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationRequestContext

  The request context.

• item
  Type: Microsoft.TeamFoundation.VersionControl.Server.ItemSpec

  The local or server path that will be recursively destroyed.

• versionSpec
  Type: Microsoft.TeamFoundation.VersionControl.Server.VersionSpec

  The version spec to resolve itemSpec with.

• stopAtSpec
  Type: Microsoft.TeamFoundation.VersionControl.Server.VersionSpec

  The simple version spec (not label or workspace) that influences keepHistory behavior.

• flags
  Type: System.Int32

  The set of destroy options KeepHistory: If set to true this means that destroy only removes the content of every version of a file up to but not including the changeset represented by stopAt Force: If set to true this means that destroy will asynchronously kick off content garbage collection Preview: If set to true no database data will actually be deleted, only the list of items that would have been destroyed are returned.

• maxClientPathLength
  Type: Microsoft.TeamFoundation.VersionControl.Common.PathLength

  The maximum client supported server path length.

Return Value

Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationDataReader
TeamFoundationDataReader with results in the following order: Item[] - The list of items that were destroyed Failure[] - List of reported failures that occured while attempting the destroy operation PendingSet[] - Set of pending changes that were destroyed PendingSet[] - Set of shelved changes that were destroyed.

.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

TeamFoundationVersionControlService Class

Destroy Overload

Microsoft.TeamFoundation.VersionControl.Server Namespace