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
Public Function Get ( _
requestContext As TeamFoundationRequestContext, _
workspaceName As String, _
ownerName As String, _
requests As GetRequest(), _
maxResults As Integer, _
getOptions As GetOptions, _
itemPropertyFilters As String(), _
itemAttributeFilters As String(), _
maxClientPathLength As PathLength _
) As TeamFoundationDataReader
public TeamFoundationDataReader Get(
TeamFoundationRequestContext requestContext,
string workspaceName,
string ownerName,
GetRequest[] requests,
int maxResults,
GetOptions getOptions,
string[] itemPropertyFilters,
string[] itemAttributeFilters,
PathLength maxClientPathLength
)
public:
TeamFoundationDataReader^ Get(
TeamFoundationRequestContext^ requestContext,
String^ workspaceName,
String^ ownerName,
array<GetRequest^>^ requests,
int maxResults,
GetOptions getOptions,
array<String^>^ itemPropertyFilters,
array<String^>^ itemAttributeFilters,
PathLength maxClientPathLength
)
member Get :
requestContext:TeamFoundationRequestContext *
workspaceName:string *
ownerName:string *
requests:GetRequest[] *
maxResults:int *
getOptions:GetOptions *
itemPropertyFilters:string[] *
itemAttributeFilters:string[] *
maxClientPathLength:PathLength -> TeamFoundationDataReader
public function Get(
requestContext : TeamFoundationRequestContext,
workspaceName : String,
ownerName : String,
requests : GetRequest[],
maxResults : int,
getOptions : GetOptions,
itemPropertyFilters : String[],
itemAttributeFilters : String[],
maxClientPathLength : PathLength
) : TeamFoundationDataReader
Parameters
requestContext
Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationRequestContextThe request context.
workspaceName
Type: System.StringName of workspace to update.
ownerName
Type: System.StringWorkspace owner user name, including domain.
requests
Type: array<Microsoft.TeamFoundation.VersionControl.Server.GetRequest[]Get operations to perform.
maxResults
Type: System.Int32If true, get even if the client is up to date according to the LocalVersion table.
getOptions
Type: Microsoft.TeamFoundation.VersionControl.Server.GetOptionsIf no get is supplied this tells the server the client is not intending to retrieve the items. It is calling as an informational command.
itemPropertyFilters
Type: array<System.String[]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.
itemAttributeFilters
Type: array<System.String[]Bitmap of options for the get operation
maxClientPathLength
Type: Microsoft.TeamFoundation.VersionControl.Common.PathLengthA list of versioned item attributes to return for each GetOperation
The max path length the client supports
Return Value
Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationDataReader
TeamFoundationDataReader with results in the following order: GetOperaton[][] - The list of items that were destroyed
.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.