VersionControlServer.Destroy Method (ItemSpec, VersionSpec, VersionSpec, DestroyFlags)

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 _
) As Item()
public Item[] Destroy(
    ItemSpec itemSpec,
    VersionSpec versionSpec,
    VersionSpec stopAt,
    DestroyFlags flags
)
public:
array<Item^>^ Destroy(
    ItemSpec^ itemSpec, 
    VersionSpec^ versionSpec, 
    VersionSpec^ stopAt, 
    DestroyFlags flags
)
member Destroy : 
        itemSpec:ItemSpec * 
        versionSpec:VersionSpec * 
        stopAt:VersionSpec * 
        flags:DestroyFlags -> Item[] 
public function Destroy(
    itemSpec : ItemSpec, 
    versionSpec : VersionSpec, 
    stopAt : VersionSpec, 
    flags : DestroyFlags
) : Item[]

Parameters

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

Return Value

Type: array<Microsoft.TeamFoundation.VersionControl.Client.Item[]
The array of items that were destroyed.

.NET Framework Security

See Also

Reference

VersionControlServer Class

Destroy Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace