VersionControlServer.Destroy Method (ItemSpec, VersionSpec, VersionSpec, DestroyFlags, array<PendingSet[]%, array<PendingSet %)

Permanently deletes the subtree, starting at the specified item.

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

Syntax

'Declaration
Public Function Destroy ( _
    itemSpec As ItemSpec, _
    versionSpec As VersionSpec, _
    stopAt As VersionSpec, _
    flags As DestroyFlags, _
    <OutAttribute> ByRef affectedPendingChanges As PendingSet(), _
    <OutAttribute> ByRef affectedShelvedChanges As PendingSet() _
) As Item()

public Item[] Destroy(
    ItemSpec itemSpec,
    VersionSpec versionSpec,
    VersionSpec stopAt,
    DestroyFlags flags,
    out PendingSet[] affectedPendingChanges,
    out PendingSet[] affectedShelvedChanges
)

public:
array<Item^>^ Destroy(
    ItemSpec^ itemSpec, 
    VersionSpec^ versionSpec, 
    VersionSpec^ stopAt, 
    DestroyFlags flags, 
    [OutAttribute] array<PendingSet^>^% affectedPendingChanges, 
    [OutAttribute] array<PendingSet^>^% affectedShelvedChanges
)

member Destroy : 
        itemSpec:ItemSpec * 
        versionSpec:VersionSpec * 
        stopAt:VersionSpec * 
        flags:DestroyFlags * 
        affectedPendingChanges:PendingSet[] byref * 
        affectedShelvedChanges:PendingSet[] byref -> Item[] 

public function Destroy(
    itemSpec : ItemSpec, 
    versionSpec : VersionSpec, 
    stopAt : VersionSpec, 
    flags : DestroyFlags, 
    affectedPendingChanges : PendingSet[], 
    affectedShelvedChanges : PendingSet[]
) : Item[]

Parameters

• itemSpec
  Type: Microsoft.TeamFoundation.VersionControl.Client.ItemSpec

  The local or server path of an item that will be recursively destroyed.

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

  The version of the item.

• stopAt
  Type: Microsoft.TeamFoundation.VersionControl.Client.VersionSpec

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

• flags
  Type: Microsoft.TeamFoundation.VersionControl.Common.DestroyFlags

  The set of destroy flags that affects the Destroy: operation. KeepHistory: True to remove only the content of every version of a file up to but not including the changeset that is represented by stopAt. Force: True to asynchronously initialize content garbage collection. Preview: True to make sure that no database data will be deleted. Only a list of items that would have been destroyed is returned. Silent: True to return no data to the client. AffectedChanges: True to enable that pending changes and shelved changes that will be destroyed will be returned in affectedPendingChanges and affectedShelvedChanges. This can be set only if Preview is set. If set, the return value array will be empty.

• affectedPendingChanges
  Type: array<Microsoft.TeamFoundation.VersionControl.Client.PendingSet[]%

  The pending changes that will be destroyed.

• affectedShelvedChanges
  Type: array<Microsoft.TeamFoundation.VersionControl.Client.PendingSet[]%

  The shelved changes that will be destroyed.

Return Value

Type: array<Microsoft.TeamFoundation.VersionControl.Client.Item[]
The array of items that were destroyed. Null if the Silent flag is specified.

.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

VersionControlServer Class

Destroy Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace