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

Queues files or folders for deletion from the 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 _
) As Integer

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

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

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

public function PendDelete(
    paths : String[], 
    recursion : RecursionType, 
    lockLevel : LockLevel, 
    updateDisk : boolean
) : 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 specifying 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 on the local disk.

Return Value

Type: System.Int32
The number of files or folders 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