This documentation is archived and is not being maintained.

Workspace::PendEdit Method (array<String>, RecursionType, String, LockLevel, Boolean, PendChangesOptions, array<String>)

Checks out files for editing from the version-control repository.

Namespace:  Microsoft.TeamFoundation.VersionControl.Client
Assembly:  Microsoft.TeamFoundation.VersionControl.Client (in Microsoft.TeamFoundation.VersionControl.Client.dll)

public:
int PendEdit(
	array<String^>^ paths, 
	RecursionType recursion, 
	String^ fileType, 
	LockLevel lockLevel, 
	bool silent, 
	PendChangesOptions options, 
	array<String^>^ itemAttributeFilters
)

Parameters

paths
Type: array<System::String>

An array of paths of files to check out for editing.

recursion
Type: Microsoft.TeamFoundation.VersionControl.Client::RecursionType

A flag that indicates the type of recursion.

fileType
Type: System::String

The new file type. May be null.

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

The lock level to apply to each file that is checked out.

silent
Type: System::Boolean

Specifies whether the server should return Get operations.

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

One or more of the enum values (ForceCheckOutLatestVersion, GetLatestOnCheckout, Silent, or None) in PendChangesOptions.

itemAttributeFilters
Type: array<System::String>

An array of property name filters.

Return Value

Type: System::Int32
The number of files that were checked out.

The options include the following flag:

GetLatestOnCheckout: Make a pending change to the most recent version of the item instead of the workspace version.

Show: