This documentation is archived and is not being maintained.

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)

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

Parameters

oldPath
Type: System::String

The current path to the item that is 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 preview the number of items that were changed but not modify the disk.

detectFolderAtTarget
Type: System::Boolean

True to search for a local folder that exists at the target and notify the server. False not to search.

silent
Type: System::Boolean

Specifies 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.

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.

Show: