Workspace.CheckIn Method (WorkspaceCheckInParameters)

Artigo
07/22/2011

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

'Declaração
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 checkin, such as (but not limited to) the items to check in, the comment associated with the changeset, and the associated work items.

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

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.

Partilhar via