This documentation is archived and is not being maintained.

Workspace::PendRename Method (String, String, LockLevel, Boolean, Boolean, PendChangesOptions, array<String>, 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)

public:
int PendRename(
	String^ oldPath, 
	String^ newPath, 
	LockLevel lockLevel, 
	bool updateDisk, 
	bool detectFolderAtTarget, 
	PendChangesOptions options, 
	array<String^>^ itemAttributeFilters, 
	array<String^>^ itemPropertyFilters
)

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

lockLevel
Type: Microsoft.TeamFoundation.VersionControl.Client::LockLevel

The level of locking for the pending change

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

options
Type: Microsoft.TeamFoundation.VersionControl.Common::PendChangesOptions

Options 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

Show: