Workspace.PendEdit Method (array<String[], RecursionType, String, LockLevel, Boolean, PendChangesOptions, array<String[], array<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)

Syntax

'Declaration
Public Function PendEdit ( _
    paths As String(), _
    recursion As RecursionType, _
    fileType As String, _
    lockLevel As LockLevel, _
    silent As Boolean, _
    options As PendChangesOptions, _
    itemAttributeFilters As String(), _
    itemPropertyFilters As String() _
) As Integer
public int PendEdit(
    string[] paths,
    RecursionType recursion,
    string fileType,
    LockLevel lockLevel,
    bool silent,
    PendChangesOptions options,
    string[] itemAttributeFilters,
    string[] itemPropertyFilters
)
public:
int PendEdit(
    array<String^>^ paths, 
    RecursionType recursion, 
    String^ fileType, 
    LockLevel lockLevel, 
    bool silent, 
    PendChangesOptions options, 
    array<String^>^ itemAttributeFilters, 
    array<String^>^ itemPropertyFilters
)
member PendEdit : 
        paths:string[] * 
        recursion:RecursionType * 
        fileType:string * 
        lockLevel:LockLevel * 
        silent:bool * 
        options:PendChangesOptions * 
        itemAttributeFilters:string[] * 
        itemPropertyFilters:string[] -> int
public function PendEdit(
    paths : String[], 
    recursion : RecursionType, 
    fileType : String, 
    lockLevel : LockLevel, 
    silent : boolean, 
    options : PendChangesOptions, 
    itemAttributeFilters : String[], 
    itemPropertyFilters : String[]
) : int

Parameters

  • paths
    Type: array<System.String[]

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

  • silent
    Type: System.Boolean

    Specifies whether server should return get ops

  • itemAttributeFilters
    Type: array<System.String[]

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

  • itemPropertyFilters
    Type: array<System.String[]

    A list of property filters.

Return Value

Type: System.Int32
The number of files checked out

.NET Framework Security

See Also

Reference

Workspace Class

PendEdit Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace