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)

Syntax

'Declaration
Public Function PendEdit ( _
    paths As String(), _
    recursion As RecursionType, _
    fileType As String, _
    lockLevel As LockLevel, _
    silent As Boolean, _
    options As PendChangesOptions, _
    propertyNameFilters As String() _
) As Integer

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

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

member PendEdit : 
        paths:string[] * 
        recursion:RecursionType * 
        fileType:string * 
        lockLevel:LockLevel * 
        silent:bool * 
        options:PendChangesOptions * 
        propertyNameFilters:string[] -> int 

public function PendEdit(
    paths : String[], 
    recursion : RecursionType, 
    fileType : String, 
    lockLevel : LockLevel, 
    silent : boolean, 
    options : PendChangesOptions, 
    propertyNameFilters : String[]
) : int

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.

• propertyNameFilters
  Type: array<System.String[]
  An array of property name filters.

Return Value

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

Remarks

The options include the following flag:

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

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

Workspace Class

PendEdit Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace