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)

Syntax

'Declaration
Public Function PendDelete ( _
    paths As String(), _
    recursion As RecursionType, _
    lockLevel As LockLevel, _
    updateDisk As Boolean, _
    silent As Boolean, _
    itemAttributeFilters As String() _
) As Integer

public int PendDelete(
    string[] paths,
    RecursionType recursion,
    LockLevel lockLevel,
    bool updateDisk,
    bool silent,
    string[] itemAttributeFilters
)

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

member PendDelete : 
        paths:string[] * 
        recursion:RecursionType * 
        lockLevel:LockLevel * 
        updateDisk:bool * 
        silent:bool * 
        itemAttributeFilters:string[] -> int

public function PendDelete(
    paths : String[], 
    recursion : RecursionType, 
    lockLevel : LockLevel, 
    updateDisk : boolean, 
    silent : boolean, 
    itemAttributeFilters : String[]
) : int

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.

.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

Workspace Class

PendDelete Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace