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

Queues files or folders for deletion from the repository and deletes them in the local workspace.

This method can recurse through the specified path to queue subitems in addition to the items matched by the specified path.

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(), _
    itemPropertyFilters As String() _
) As Integer
public int PendDelete(
    string[] paths,
    RecursionType recursion,
    LockLevel lockLevel,
    bool updateDisk,
    bool silent,
    string[] itemAttributeFilters,
    string[] itemPropertyFilters
)
public:
int PendDelete(
    array<String^>^ paths, 
    RecursionType recursion, 
    LockLevel lockLevel, 
    bool updateDisk, 
    bool silent, 
    array<String^>^ itemAttributeFilters, 
    array<String^>^ itemPropertyFilters
)
member PendDelete : 
        paths:string[] * 
        recursion:RecursionType * 
        lockLevel:LockLevel * 
        updateDisk:bool * 
        silent:bool * 
        itemAttributeFilters:string[] * 
        itemPropertyFilters:string[] -> int
public function PendDelete(
    paths : String[], 
    recursion : RecursionType, 
    lockLevel : LockLevel, 
    updateDisk : boolean, 
    silent : boolean, 
    itemAttributeFilters : String[], 
    itemPropertyFilters : String[]
) : int

Parameters

  • paths
    Type: array<System.String[]

    A list of paths, local or server, representing items to be deleted

  • updateDisk
    Type: System.Boolean

    Specifies whether the deleted files should be deleted on the local disk

  • silent
    Type: System.Boolean

    Specifies whether server should return get ops

  • itemAttributeFilters
    Type: array<System.String[]

    List of properties to return with get ops

  • itemPropertyFilters
    Type: array<System.String[]

    List of property filters.

Return Value

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

.NET Framework Security

See Also

Reference

Workspace Class

PendDelete Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace