Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

Workspace.PendEdit Method (String[], RecursionType, String, LockLevel, Boolean, PendChangesOptions, String[], String[])

Checks out files for editing from the repository.

Note that fileSpec may have wildcard characters only in the last element of the path (e.g., c:\abc*z\def\xyz is not allowed, but c:\abc\def\*.cs is).

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

public int PendEdit(
	string[] paths,
	RecursionType recursion,
	string fileType,
	LockLevel lockLevel,
	bool silent,
	PendChangesOptions options,
	string[] itemAttributeFilters,
	string[] itemPropertyFilters
)

Parameters

paths
Type: System.String[]

A list of paths, local or server, to checkout for editing

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

recursion level

fileType
Type: System.String

if non-null, the new file type

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

the lock level to apply to each file checked out

silent
Type: System.Boolean

Specifies whether server should return get ops

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

The set of PendChanges options. Some relevant flags for PendEdit are as follows: GetLatestOnCheckout: Pend an edit against the latest version of the item instead of the workspace version.

itemAttributeFilters
Type: System.String[]

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

itemPropertyFilters
Type: System.String[]

A list of property filters.

Return Value

Type: System.Int32
The number of files checked out

Show:
© 2015 Microsoft