Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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(), _
itemPropertyFilters As String() _
) As Integer
public int PendRename(
string oldPath,
string newPath,
LockLevel lockLevel,
bool updateDisk,
bool detectFolderAtTarget,
PendChangesOptions options,
string[] itemAttributeFilters,
string[] itemPropertyFilters
)
public:
int PendRename(
String^ oldPath,
String^ newPath,
LockLevel lockLevel,
bool updateDisk,
bool detectFolderAtTarget,
PendChangesOptions options,
array<String^>^ itemAttributeFilters,
array<String^>^ itemPropertyFilters
)
member PendRename :
oldPath:string *
newPath:string *
lockLevel:LockLevel *
updateDisk:bool *
detectFolderAtTarget:bool *
options:PendChangesOptions *
itemAttributeFilters:string[] *
itemPropertyFilters:string[] -> int
public function PendRename(
oldPath : String,
newPath : String,
lockLevel : LockLevel,
updateDisk : boolean,
detectFolderAtTarget : boolean,
options : PendChangesOptions,
itemAttributeFilters : String[],
itemPropertyFilters : String[]
) : int
Parameters
oldPath
Type: System.StringThe current path, local or server, to the item being renamed.
newPath
Type: System.StringThe new path, local or server, for the item
lockLevel
Type: Microsoft.TeamFoundation.VersionControl.Client.LockLevelThe level of locking for the pending change
updateDisk
Type: System.Booleanif 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.Booleanif true, look for a local folder existing at the target and tell the server if that is the case; otherwise, do not check
options
Type: Microsoft.TeamFoundation.VersionControl.Common.PendChangesOptionsOptions for the call to PendChanges
itemAttributeFilters
Type: array<System.String[]A list of versioned item properties to return with each get operation
itemPropertyFilters
Type: array<System.String[]The list of property filters.
Return Value
Type: System.Int32
The number of items renamed
.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.