Repository5.Get Method

Called by the client to synchronize the workspace with a given version. Returns a "to do" list of files for the client to download to update the user's local working copies.

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

Syntax

'Declaration
<WebMethodAttribute> _
Public Function Get ( _
    workspaceName As String, _
    ownerName As String, _
    requests As GetRequest(), _
    maxResults As Integer, _
    options As Integer, _
    itemPropertyFilters As String(), _
    itemAttributeFilters As String(), _
    maxClientPathLength As Integer _
) As List(Of StreamingCollection(Of GetOperation))

[WebMethodAttribute]
public List<StreamingCollection<GetOperation>> Get(
    string workspaceName,
    string ownerName,
    GetRequest[] requests,
    int maxResults,
    int options,
    string[] itemPropertyFilters,
    string[] itemAttributeFilters,
    int maxClientPathLength
)

[WebMethodAttribute]
public:
List<StreamingCollection<GetOperation^>^>^ Get(
    String^ workspaceName, 
    String^ ownerName, 
    array<GetRequest^>^ requests, 
    int maxResults, 
    int options, 
    array<String^>^ itemPropertyFilters, 
    array<String^>^ itemAttributeFilters, 
    int maxClientPathLength
)

[<WebMethodAttribute>]
member Get : 
        workspaceName:string * 
        ownerName:string * 
        requests:GetRequest[] * 
        maxResults:int * 
        options:int * 
        itemPropertyFilters:string[] * 
        itemAttributeFilters:string[] * 
        maxClientPathLength:int -> List<StreamingCollection<GetOperation>> 

public function Get(
    workspaceName : String, 
    ownerName : String, 
    requests : GetRequest[], 
    maxResults : int, 
    options : int, 
    itemPropertyFilters : String[], 
    itemAttributeFilters : String[], 
    maxClientPathLength : int
) : List<StreamingCollection<GetOperation>>

Parameters

• workspaceName
  Type: System.String

  Name of workspace to update.

• ownerName
  Type: System.String

  Workspace owner user name, including domain.

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

  Get operations to perform.

• maxResults
  Type: System.Int32

  Limit total number of results that can be returned. A value of 0 indicates no limit. Allows a client to page Get operations. Successive calls will automatically advance the results as the client processes the previous page. This is incompatible with force option.

• options
  Type: System.Int32

  Bitmap of options for the get operation.

• itemPropertyFilters
  Type: array<System.String[]

• itemAttributeFilters
  Type: array<System.String[]

  A list of versioned item properties to return for each GetOperation.

• maxClientPathLength
  Type: System.Int32

  The maximum supported path length.

Return Value

Type: System.Collections.Generic.List<StreamingCollection<GetOperation>>
One result per request.

.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

Repository5 Class

Microsoft.TeamFoundation.VersionControl.Server Namespace