Workspace.CheckIn Method (array<PendingChange[], String, String, CheckinNote, array<WorkItemCheckinInfo[], PolicyOverrideInfo)

Checks in a set of pending changes.

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

Syntax

'Declaration
Public Function CheckIn ( _
    changes As PendingChange(), _
    author As String, _
    comment As String, _
    checkinNote As CheckinNote, _
    workItemChanges As WorkItemCheckinInfo(), _
    policyOverride As PolicyOverrideInfo _
) As Integer

'Usage
Dim instance As Workspace 
Dim changes As PendingChange()
Dim author As String 
Dim comment As String 
Dim checkinNote As CheckinNote 
Dim workItemChanges As WorkItemCheckinInfo()
Dim policyOverride As PolicyOverrideInfo 
Dim returnValue As Integer 

returnValue = instance.CheckIn(changes, _
    author, comment, checkinNote, workItemChanges, _
    policyOverride)

public int CheckIn(
    PendingChange[] changes,
    string author,
    string comment,
    CheckinNote checkinNote,
    WorkItemCheckinInfo[] workItemChanges,
    PolicyOverrideInfo policyOverride
)

public:
int CheckIn(
    array<PendingChange^>^ changes, 
    String^ author, 
    String^ comment, 
    CheckinNote^ checkinNote, 
    array<WorkItemCheckinInfo^>^ workItemChanges, 
    PolicyOverrideInfo^ policyOverride
)

public function CheckIn(
    changes : PendingChange[], 
    author : String, 
    comment : String, 
    checkinNote : CheckinNote, 
    workItemChanges : WorkItemCheckinInfo[], 
    policyOverride : PolicyOverrideInfo
) : int

Parameters

• changes
  Type: array<Microsoft.TeamFoundation.VersionControl.Client.PendingChange[]

  List of changes to check in.

• author
  Type: System.String

  If non-null, this identity will be listed in history for the committed changeset. The user running this operation must have the CheckinOther permission.

• comment
  Type: System.String

  Comment to go together with the check-in.

• checkinNote
  Type: Microsoft.TeamFoundation.VersionControl.Client.CheckinNote

  Any applicable check-in notes data.

• workItemChanges
  Type: array<Microsoft.TeamFoundation.VersionControl.Client.WorkItemCheckinInfo[]

  List of work item changes to occur with this check-in.

• policyOverride
  Type: Microsoft.TeamFoundation.VersionControl.Client.PolicyOverrideInfo

  If non-null, policy failures are being overridden.

Return Value

Type: System.Int32
Returns the Changeset number created by the check-in.

Remarks

Check-ins are atomic; they either all succeed or they all fail. If any merges must occur before the check-in, the check-in operation will throw an exception that lists all the merges that must be completed first. If there is a failure in any operation leading up to the commit of the final check-in (uploading files, and so on), the operation is aborted and an exception is thrown.

If the updating client state fails after the commit operation, a non-fatal error is reported and the operation continues.

.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

Workspace Members

CheckIn Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace