Repository.Destroy Method

Destroy the subtree represented by itemSpec.

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

Syntax

'Declaration
<WebMethodAttribute> _
Public Function Destroy ( _
    item As ItemSpec, _
    versionSpec As VersionSpec, _
    stopAtSpec As VersionSpec, _
    flags As Integer, _
    <OutAttribute> ByRef failures As Failure(), _
    <OutAttribute> ByRef pendingChanges As StreamingCollection(Of PendingSet), _
    <OutAttribute> ByRef shelvedChanges As StreamingCollection(Of PendingSet) _
) As Item()

[WebMethodAttribute]
public Item[] Destroy(
    ItemSpec item,
    VersionSpec versionSpec,
    VersionSpec stopAtSpec,
    int flags,
    out Failure[] failures,
    out StreamingCollection<PendingSet> pendingChanges,
    out StreamingCollection<PendingSet> shelvedChanges
)

[WebMethodAttribute]
public:
array<Item^>^ Destroy(
    ItemSpec^ item, 
    VersionSpec^ versionSpec, 
    VersionSpec^ stopAtSpec, 
    int flags, 
    [OutAttribute] array<Failure^>^% failures, 
    [OutAttribute] StreamingCollection<PendingSet^>^% pendingChanges, 
    [OutAttribute] StreamingCollection<PendingSet^>^% shelvedChanges
)

[<WebMethodAttribute>]
member Destroy : 
        item:ItemSpec * 
        versionSpec:VersionSpec * 
        stopAtSpec:VersionSpec * 
        flags:int * 
        failures:Failure[] byref * 
        pendingChanges:StreamingCollection<PendingSet> byref * 
        shelvedChanges:StreamingCollection<PendingSet> byref -> Item[] 

public function Destroy(
    item : ItemSpec, 
    versionSpec : VersionSpec, 
    stopAtSpec : VersionSpec, 
    flags : int, 
    failures : Failure[], 
    pendingChanges : StreamingCollection<PendingSet>, 
    shelvedChanges : StreamingCollection<PendingSet>
) : Item[]

Parameters

• 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 excluding the changeset represented by stop. At Force: if set to true this means that destroy will asynchronously start 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.

• failures
  Type: array<Microsoft.TeamFoundation.VersionControl.Server.Failure[]%

  An output parameter that reports the failures if any that occurred while it tries the destroy operation.

• pendingChanges
  Type: Microsoft.TeamFoundation.Framework.Server.StreamingCollection<PendingSet>%

• shelvedChanges
  Type: Microsoft.TeamFoundation.Framework.Server.StreamingCollection<PendingSet>%

Return Value

Type: array<Microsoft.TeamFoundation.VersionControl.Server.Item[]
The list of items 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

Repository Class

Microsoft.TeamFoundation.VersionControl.Server Namespace