Workspace.PendRename Method (String, String, LockLevel, Boolean, Boolean, Boolean)

Moves or renames a file or directory.

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, _
    silent As Boolean _
) As Integer

public int PendRename(
    string oldPath,
    string newPath,
    LockLevel lockLevel,
    bool updateDisk,
    bool detectFolderAtTarget,
    bool silent
)

public:
int PendRename(
    String^ oldPath, 
    String^ newPath, 
    LockLevel lockLevel, 
    bool updateDisk, 
    bool detectFolderAtTarget, 
    bool silent
)

member PendRename : 
        oldPath:string * 
        newPath:string * 
        lockLevel:LockLevel * 
        updateDisk:bool * 
        detectFolderAtTarget:bool * 
        silent:bool -> int 

public function PendRename(
    oldPath : String, 
    newPath : String, 
    lockLevel : LockLevel, 
    updateDisk : boolean, 
    detectFolderAtTarget : boolean, 
    silent : boolean
) : int

Parameters

• oldPath
  Type: System.String
  The current path to the item being renamed.

• newPath
  Type: System.String
  The new path for the item.

• lockLevel
  Type: Microsoft.TeamFoundation.VersionControl.Client.LockLevel
  The level of locking for the pending change.

• updateDisk
  Type: System.Boolean
  True to update the local disk according to the pending changes. False to not modify disk (will only preview the number of items changed).

• detectFolderAtTarget
  Type: System.Boolean
  True to search for a local folder existing at the target and notify the server. False to not search.

• silent
  Type: System.Boolean
  Specifies whether server should return get operations.

Return Value

Type: System.Int32
The number of items renamed.

Remarks

The oldPath may contain wildcards if the target is a directory. The newPath may never have wildcards. If the target is an existing directory, the source will be moved to be a child of the target.

.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

PendRename Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace