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

Article
07/02/2014

Checks in the specified set of pending changes to the version-control repository.

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

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
)

member CheckIn : 
        changes:PendingChange[] * 
        author:string * 
        comment:string * 
        checkinNote:CheckinNote * 
        workItemChanges:WorkItemCheckinInfo[] * 
        policyOverride:PolicyOverrideInfo -> int

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[]

The set of pending changes to check in. If you do not specify this parameter, all changes in the workspace are checked in.

author
Type: System.String

The author of the changeset. If you do not specify this parameter, the user who is making the check-in call is identified as the author.

comment
Type: System.String

The comment to be associated with this check-in. May be null.

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

CheckinNote information to be associated with this check-in. The default check-in notes are for security reviewer, performance reviewer, and code reviewer. May be null.

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

Information about associated work items. May be null.

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

Information that the user provided to override a check-in policy. May be null.

Return Value

Type: System.Int32
If successful, a positive changeset number for this check-in.

Exceptions

Exception	Condition
VersionControlException	This workspace has been deleted.

Remarks

Each check-in is an atomic operation. All changes are checked in, or none are. If the check-in is successful, the method returns a positive changeset number. If the set of pending changes for the check-in is null, the server tries to check in all changes in the workspace. However, this operation is not valid if any pending changes in the workspace are edits or adds, because content will not have been uploaded to the server.

.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.