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

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 ( _
    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

changes
Type: array<Microsoft.TeamFoundation.VersionControl.Client.PendingChange[]
The set of pending changes to check in. Null to check-in all changes in the workspace.

author
Type: System.String
The author of the changeset. If null, the user making check-in call is 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 associated with this check-in. May be null.

workItemChanges
Type: array<Microsoft.TeamFoundation.VersionControl.Client.WorkItemCheckinInfo[]
Associated work item information. May be null.

policyOverride
Type: Microsoft.TeamFoundation.VersionControl.Client.PolicyOverrideInfo
Check-in policy override information. May be null.

checkinOptions
Type: Microsoft.TeamFoundation.VersionControl.Client.CheckinOptions
Options for the 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

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.

Compartilhar via