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

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, _
    checkinOptions As CheckinOptions _
) As Integer
public int CheckIn(
    PendingChange[] changes,
    string author,
    string comment,
    CheckinNote checkinNote,
    WorkItemCheckinInfo[] workItemChanges,
    PolicyOverrideInfo policyOverride,
    CheckinOptions checkinOptions
)
public:
int CheckIn(
    array<PendingChange^>^ changes, 
    String^ author, 
    String^ comment, 
    CheckinNote^ checkinNote, 
    array<WorkItemCheckinInfo^>^ workItemChanges, 
    PolicyOverrideInfo^ policyOverride, 
    CheckinOptions checkinOptions
)
member CheckIn : 
        changes:PendingChange[] * 
        author:string * 
        comment:string * 
        checkinNote:CheckinNote * 
        workItemChanges:WorkItemCheckinInfo[] * 
        policyOverride:PolicyOverrideInfo * 
        checkinOptions:CheckinOptions -> int
public function CheckIn(
    changes : PendingChange[], 
    author : String, 
    comment : String, 
    checkinNote : CheckinNote, 
    workItemChanges : WorkItemCheckinInfo[], 
    policyOverride : PolicyOverrideInfo, 
    checkinOptions : CheckinOptions
) : int

Parameters

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

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

See Also

Reference

Workspace Class

CheckIn Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace