This documentation is archived and is not being maintained.
VersionControlServer::Destroy Method (ItemSpec, VersionSpec, VersionSpec, DestroyFlags)
Visual Studio 2013
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)
public: array<Item^>^ Destroy( ItemSpec^ itemSpec, VersionSpec^ versionSpec, VersionSpec^ stopAt, DestroyFlags flags )
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.
Return Value
Type: array<Microsoft.TeamFoundation.VersionControl.Client::Item>The array of items that were destroyed.
- 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.
Show: