This documentation is archived and is not being maintained.

Workspace.PendRename Method (String, String, LockLevel, Boolean, Boolean, PendChangesOptions, String[], 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,
	string[] itemAttributeFilters,
	string[] itemPropertyFilters


Type: System.String

The current path, local or server, to the item being renamed.

Type: System.String

The new path, local or server, for the item

Type: Microsoft.TeamFoundation.VersionControl.Client.LockLevel

The level of locking for the pending change

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

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

Type: Microsoft.TeamFoundation.VersionControl.Common.PendChangesOptions

Options for the call to PendChanges

Type: System.String[]

A list of versioned item properties to return with each get operation

Type: System.String[]

The list of property filters.

Return Value

Type: System.Int32
The number of items renamed