Workspace.CheckIn Method (array<PendingChange , String)

Performs a check-in of the specified set of pending changes to the server.

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

Syntax

'宣言
Public Function CheckIn ( _
    changes As PendingChange(), _
    comment As String _
) As Integer
public int CheckIn(
    PendingChange[] changes,
    string comment
)
public:
int CheckIn(
    array<PendingChange^>^ changes, 
    String^ comment
)
member CheckIn : 
        changes:PendingChange[] * 
        comment:string -> int 
public function CheckIn(
    changes : PendingChange[], 
    comment : String
) : int

Parameters

  • 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

A check-in is an atomic operation. All changes will be checked in or none will. If the checkin is successful, a positive changeset number will be returned from this method. If the set of pending changes for checkin is null, the server will attempt to check in all changes in the workspace, but this operation is not valid if any pending changes in the workspace are edits or adds, as content will not have been uploaded to the server.

.NET Framework Security

See Also

Reference

Workspace Class

CheckIn Overload

Microsoft.TeamFoundation.VersionControl.Client Namespace