Workspace.Get Method (array<GetRequest[], GetOptions, GetFilterCallback, Object, array<String[], array<String[], array<Conflict %)

Get requests that the server update the current workspace with the specified versions of the items. The filtering delegate allows the caller to discard operations before they are processed by setting the Ignore property on each operation to be discarded.

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

Syntax

'Declaration
Public Function Get ( _
    requests As GetRequest(), _
    options As GetOptions, _
    filterCallback As GetFilterCallback, _
    userData As Object, _
    itemAttributeFilters As String(), _
    itemPropertyFilters As String(), _
    <OutAttribute> ByRef conflicts As Conflict() _
) As GetStatus

public GetStatus Get(
    GetRequest[] requests,
    GetOptions options,
    GetFilterCallback filterCallback,
    Object userData,
    string[] itemAttributeFilters,
    string[] itemPropertyFilters,
    out Conflict[] conflicts
)

public:
GetStatus^ Get(
    array<GetRequest^>^ requests, 
    GetOptions options, 
    GetFilterCallback^ filterCallback, 
    Object^ userData, 
    array<String^>^ itemAttributeFilters, 
    array<String^>^ itemPropertyFilters, 
    [OutAttribute] array<Conflict^>^% conflicts
)

member Get : 
        requests:GetRequest[] * 
        options:GetOptions * 
        filterCallback:GetFilterCallback * 
        userData:Object * 
        itemAttributeFilters:string[] * 
        itemPropertyFilters:string[] * 
        conflicts:Conflict[] byref -> GetStatus

public function Get(
    requests : GetRequest[], 
    options : GetOptions, 
    filterCallback : GetFilterCallback, 
    userData : Object, 
    itemAttributeFilters : String[], 
    itemPropertyFilters : String[], 
    conflicts : Conflict[]
) : GetStatus

Parameters

• requests
  Type: array<Microsoft.TeamFoundation.VersionControl.Client.GetRequest[]

  the items and versions being requested

• options
  Type: Microsoft.TeamFoundation.VersionControl.Client.GetOptions

  options for the get (all, overwrite, etc.)

• filterCallback
  Type: Microsoft.TeamFoundation.VersionControl.Client.GetFilterCallback

  a delegate to be called by using the operations obtained from the server before the operations are processed

• userData
  Type: System.Object

  a user-specified object passed to the delegate when it is called

• itemAttributeFilters
  Type: array<System.String[]

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

• itemPropertyFilters
  Type: array<System.String[]

• conflicts
  Type: array<Microsoft.TeamFoundation.VersionControl.Client.Conflict[]%

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Client.GetStatus
a GetStatus object describing the number of operations, conflicts, errors, and so on that occurred when processing the get

.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

Get Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace