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