Workspace.PendRename Method (String, String, LockLevel, Boolean, Boolean, Boolean, array<String )
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, _
itemAttributeFilters As String() _
) As Integer
public int PendRename(
string oldPath,
string newPath,
LockLevel lockLevel,
bool updateDisk,
bool detectFolderAtTarget,
bool silent,
string[] itemAttributeFilters
)
public:
int PendRename(
String^ oldPath,
String^ newPath,
LockLevel lockLevel,
bool updateDisk,
bool detectFolderAtTarget,
bool silent,
array<String^>^ itemAttributeFilters
)
member PendRename :
oldPath:string *
newPath:string *
lockLevel:LockLevel *
updateDisk:bool *
detectFolderAtTarget:bool *
silent:bool *
itemAttributeFilters:string[] -> int
public function PendRename(
oldPath : String,
newPath : String,
lockLevel : LockLevel,
updateDisk : boolean,
detectFolderAtTarget : boolean,
silent : boolean,
itemAttributeFilters : String[]
) : int
Parameters
oldPath
Type: System.StringThe current path to the item that is being renamed.
newPath
Type: System.StringThe new path for the item.
lockLevel
Type: Microsoft.TeamFoundation.VersionControl.Client.LockLevelThe level of locking for the pending change.
updateDisk
Type: System.BooleanTrue to update the local disk according to the pending changes. False to preview the number of items that were changed but not modify the disk.
detectFolderAtTarget
Type: System.BooleanTrue to search for a local folder that exists at the target and notify the server. False not to search.
silent
Type: System.BooleanSpecifies whether the server should return Get operations.
itemAttributeFilters
Type: array<System.String[]An array of versioned item properties to return with each Get operation.
Return Value
Type: System.Int32
The number of items that were moved or renamed.
Remarks
The oldPath parameter may contain wildcard characters if the target is a directory. The newPath parameter cannot have wildcard characters. 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.