Workspace.PendRename Method (String, String, LockLevel, Boolean, Boolean, PendChangesOptions, array<String )

Moves or renames a file or directory. The source may contain wildcard characters if the target is a directory. The target may never have wildcard characters. If the target is an existing directory, the source will be moved to be a child of the target.

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

Syntax

'Declaration
Public Function PendRename ( _
    oldPath As String, _
    newPath As String, _
    lockLevel As LockLevel, _
    updateDisk As Boolean, _
    detectFolderAtTarget As Boolean, _
    options As PendChangesOptions, _
    itemAttributeFilters As String() _
) As Integer
public int PendRename(
    string oldPath,
    string newPath,
    LockLevel lockLevel,
    bool updateDisk,
    bool detectFolderAtTarget,
    PendChangesOptions options,
    string[] itemAttributeFilters
)
public:
int PendRename(
    String^ oldPath, 
    String^ newPath, 
    LockLevel lockLevel, 
    bool updateDisk, 
    bool detectFolderAtTarget, 
    PendChangesOptions options, 
    array<String^>^ itemAttributeFilters
)
member PendRename : 
        oldPath:string * 
        newPath:string * 
        lockLevel:LockLevel * 
        updateDisk:bool * 
        detectFolderAtTarget:bool * 
        options:PendChangesOptions * 
        itemAttributeFilters:string[] -> int
public function PendRename(
    oldPath : String, 
    newPath : String, 
    lockLevel : LockLevel, 
    updateDisk : boolean, 
    detectFolderAtTarget : boolean, 
    options : PendChangesOptions, 
    itemAttributeFilters : String[]
) : int

Parameters

  • oldPath
    Type: System.String

    The current path, local or server, to the item being renamed.

  • newPath
    Type: System.String

    The new path, local or server, for the item

  • updateDisk
    Type: System.Boolean

    if true, the local disk is updated according to the pending changes; if false, the disk is not modified and changes are not acknowledged

  • detectFolderAtTarget
    Type: System.Boolean

    if true, look for a local folder existing at the target and tell the server if that is the case; otherwise, do not check

  • itemAttributeFilters
    Type: array<System.String[]

    A list of versioned item properties to return with each get operation

Return Value

Type: System.Int32
The number of items renamed

.NET Framework Security

See Also

Reference

Workspace Class

PendRename Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace