TeamFoundationVersionControlService.CheckIn Method

Commits a set of pending changes. Checkin is part of a larger call sequence to commit files. The sequence is: 1. Call CheckPendingChanges and pass in the list of files and folders to checkin. 2. For each file call UploadFile. 3. Call Checkin and pass the list of files and folders (should match the list in #1). CheckPendingChanges is not required, but it allows the caller to be alerted of conflicts before wasting time uploading files.

serverItems must contain at least one item, no duplicates, and no wildcard characters.

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

Syntax

'Declaration
Public Function CheckIn ( _
    requestContext As TeamFoundationRequestContext, _
    workspaceName As String, _
    ownerName As String, _
    serverItems As String(), _
    info As Changeset, _
    checkinNotificationInfo As CheckinNotificationInfo, _
    checkinOptions As Integer, _
    deferCheckIn As Boolean, _
    checkInTicket As Integer _
) As TeamFoundationDataReader

public TeamFoundationDataReader CheckIn(
    TeamFoundationRequestContext requestContext,
    string workspaceName,
    string ownerName,
    string[] serverItems,
    Changeset info,
    CheckinNotificationInfo checkinNotificationInfo,
    int checkinOptions,
    bool deferCheckIn,
    int checkInTicket
)

public:
TeamFoundationDataReader^ CheckIn(
    TeamFoundationRequestContext^ requestContext, 
    String^ workspaceName, 
    String^ ownerName, 
    array<String^>^ serverItems, 
    Changeset^ info, 
    CheckinNotificationInfo^ checkinNotificationInfo, 
    int checkinOptions, 
    bool deferCheckIn, 
    int checkInTicket
)

member CheckIn : 
        requestContext:TeamFoundationRequestContext * 
        workspaceName:string * 
        ownerName:string * 
        serverItems:string[] * 
        info:Changeset * 
        checkinNotificationInfo:CheckinNotificationInfo * 
        checkinOptions:int * 
        deferCheckIn:bool * 
        checkInTicket:int -> TeamFoundationDataReader

public function CheckIn(
    requestContext : TeamFoundationRequestContext, 
    workspaceName : String, 
    ownerName : String, 
    serverItems : String[], 
    info : Changeset, 
    checkinNotificationInfo : CheckinNotificationInfo, 
    checkinOptions : int, 
    deferCheckIn : boolean, 
    checkInTicket : int
) : TeamFoundationDataReader

Parameters

• requestContext
  Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationRequestContext

  The request context.

• workspaceName
  Type: System.String

  Name of workspace that contains changes to submit.

• ownerName
  Type: System.String

  Owner of the workspace.

• serverItems
  Type: array<System.String[]

  List of items to checkin.

• info
  Type: Microsoft.TeamFoundation.VersionControl.Server.Changeset

  Changeset metadata. Used to provide owner, comment, checkin note, date, and additional information.

• checkinNotificationInfo
  Type: Microsoft.TeamFoundation.VersionControl.Server.CheckinNotificationInfo

  The information needed by the checkin notification service.

• checkinOptions
  Type: System.Int32

  Per-checkin options that affect event generation, checkin author validation, and gated checkin.

• deferCheckIn
  Type: System.Boolean

  True if the checkin should be deferred and a checkinTicket should be assigned if not already provided. False to commit the checkin with this call.

• checkInTicket
  Type: System.Int32

  Pass 0 if this is either a non-deferred checkin, or if this is the first call in a deferred checkin session. Otherwise, pass the checkInTicket that was returned from the previous call(s).

Return Value

Type: Microsoft.TeamFoundation.Framework.Server.TeamFoundationDataReader
TeamFoundationDataReader with results in the following order: CheckInResult - The checkin result with the changeset created and the undone changes. Failure[] - The list of conflicts which occurred when trying to check in. Failure[] - The list of errors and warnings which occurred when trying to check in.

Remarks

The Changes and Number properties of information are ignored. Owner and CreationDate should be left at their default values unless you are checking in on behalf of someone else, or checking in an imported change (conversion tool).

.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

TeamFoundationVersionControlService Class

Microsoft.TeamFoundation.VersionControl.Server Namespace