This documentation is archived and is not being maintained.

Workspace::PendDelete Method (array<String>, RecursionType, LockLevel, Boolean, Boolean, array<String>)

Queues files or folders for deletion from the version-control repository.

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

public:
int PendDelete(
	array<String^>^ paths, 
	RecursionType recursion, 
	LockLevel lockLevel, 
	bool updateDisk, 
	bool silent, 
	array<String^>^ itemAttributeFilters
)

Parameters

paths
Type: array<System::String>

An array of local paths to the items to delete.

recursion
Type: Microsoft.TeamFoundation.VersionControl.Client::RecursionType

A flag that specifies the type of recursion.

lockLevel
Type: Microsoft.TeamFoundation.VersionControl.Client::LockLevel

The lock level to apply to each item.

updateDisk
Type: System::Boolean

True to delete files from the local disk.

silent
Type: System::Boolean

Specifies whether the server should return Get operations.

itemAttributeFilters
Type: array<System::String>

The list of properties to return with Get operations.

Return Value

Type: System::Int32
The number of files or folders that are queued for deletion.

Show: