Commits a set of pending changes. Checkin is part of a larger call sequence to commit files. The sequence is: 1. Call CheckPendingChanges and pass in the list of files and folders to checkin 2. For each file call UploadFile 3. Call Checkin and pass the list of files and folders (should match the list in #1) CheckPendingChanges isn't necessary, but it allows the caller to be alerted of conflicts before wasting time uploading files. serverItems must contain at least one item, no duplicates, and no wildcards.
Namespace: Microsoft.TeamFoundation.VersionControl.Server
Assembly: Microsoft.TeamFoundation.VersionControl.Server (in Microsoft.TeamFoundation.VersionControl.Server.dll)
Syntax
'Declaration
<WebMethodAttribute> _
Public Function CheckIn ( _
workspaceName As String, _
ownerName As String, _
serverItems As String(), _
info As Changeset, _
checkinNotificationInfo As CheckinNotificationInfo, _
checkinOptions As Integer, _
<OutAttribute> ByRef conflicts As StreamingCollection(Of Failure), _
<OutAttribute> ByRef failures As StreamingCollection(Of Failure), _
deferCheckIn As Boolean, _
checkInTicket As Integer, _
maxClientPathLength As Integer _
) As CheckinResult
[WebMethodAttribute]
public CheckinResult CheckIn(
string workspaceName,
string ownerName,
string[] serverItems,
Changeset info,
CheckinNotificationInfo checkinNotificationInfo,
int checkinOptions,
out StreamingCollection<Failure> conflicts,
out StreamingCollection<Failure> failures,
bool deferCheckIn,
int checkInTicket,
int maxClientPathLength
)
[WebMethodAttribute]
public:
CheckinResult^ CheckIn(
String^ workspaceName,
String^ ownerName,
array<String^>^ serverItems,
Changeset^ info,
CheckinNotificationInfo^ checkinNotificationInfo,
int checkinOptions,
[OutAttribute] StreamingCollection<Failure^>^% conflicts,
[OutAttribute] StreamingCollection<Failure^>^% failures,
bool deferCheckIn,
int checkInTicket,
int maxClientPathLength
)
[<WebMethodAttribute>]
member CheckIn :
workspaceName:string *
ownerName:string *
serverItems:string[] *
info:Changeset *
checkinNotificationInfo:CheckinNotificationInfo *
checkinOptions:int *
conflicts:StreamingCollection<Failure> byref *
failures:StreamingCollection<Failure> byref *
deferCheckIn:bool *
checkInTicket:int *
maxClientPathLength:int -> CheckinResult
public function CheckIn(
workspaceName : String,
ownerName : String,
serverItems : String[],
info : Changeset,
checkinNotificationInfo : CheckinNotificationInfo,
checkinOptions : int,
conflicts : StreamingCollection<Failure>,
failures : StreamingCollection<Failure>,
deferCheckIn : boolean,
checkInTicket : int,
maxClientPathLength : int
) : CheckinResult
Parameters
workspaceName
Type: System.StringName of workspace containing changes to submit.
ownerName
Type: System.StringOwner of the workspace.
serverItems
Type: array<System.String[]List of items to checkin.
info
Type: Microsoft.TeamFoundation.VersionControl.Server.ChangesetChangeset meta-data. Used to provide owner, comment, checkin note, date, and additional information.
checkinNotificationInfo
Type: Microsoft.TeamFoundation.VersionControl.Server.CheckinNotificationInfoThe information needed by the checkin notification service.
checkinOptions
Type: System.Int32The options for the checkin operation.
conflicts
Type: Microsoft.TeamFoundation.Framework.Server.StreamingCollection<Failure>%The conflicts filed by this checkin.
failures
Type: Microsoft.TeamFoundation.Framework.Server.StreamingCollection<Failure>%The errors and warnings hit by this checkin.
deferCheckIn
Type: System.BooleanTrue if the checkin should be deferred and a checkinTicket should be assigned if not already provided. False to commit the checkin with this call.
checkInTicket
Type: System.Int32Pass 0 if this is either a non-deferred checkin, or if this is the first call in a deferred checkin session. Otherwise, pass the checkInTicket that was returned from the previous call(s).
maxClientPathLength
Type: System.Int32The maximum client supported server path length.
Return Value
Type: Microsoft.TeamFoundation.VersionControl.Server.CheckinResult
This returns a checkin result with the changeset created and the undone changes.
Remarks
The Changes and Number properties of info are ignored. Owner and CreationDate should be left at their default values unless you are checking in on behalf of someone else, or checking in an imported change (conversion tool).
.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.