Workspace.CheckIn Method (WorkspaceCheckInParameters)

Article
11/19/2013

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 ( _
    checkinParameters As WorkspaceCheckInParameters _
) As Integer

public int CheckIn(
    WorkspaceCheckInParameters checkinParameters
)

public:
int CheckIn(
    WorkspaceCheckInParameters^ checkinParameters
)

member CheckIn : 
        checkinParameters:WorkspaceCheckInParameters -> int

public function CheckIn(
    checkinParameters : WorkspaceCheckInParameters
) : int

Parameters

checkinParameters
Type: Microsoft.TeamFoundation.VersionControl.Client.WorkspaceCheckInParameters

An instance of WorkspaceCheckInParameters that you create to supply instructions for this check-in, such as (but not limited to) the items to check in, the comment to associate with the changeset, and the work items that are associated with this check-in.

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 version-control repository.

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

Share via