Repository5.CheckInShelveset Method

Submit an existing shelveset for checkin. Work items associated with the changeset will be either associated or resolved once the checkin completes.

Namespace:  Microsoft.TeamFoundation.VersionControl.Server
Assembly:  Microsoft.TeamFoundation.VersionControl.Server (in Microsoft.TeamFoundation.VersionControl.Server.dll)

Syntax

'Declaration
<WebMethodAttribute> _
Public Function CheckInShelveset ( _
    shelvesetName As String, _
    ownerName As String, _
    changesetOwner As String, _
    checkinNotificationInfo As CheckinNotificationInfo, _
    checkinOptions As Integer, _
    maxClientPathLength As Integer, _
    <OutAttribute> ByRef conflicts As StreamingCollection(Of Failure), _
    <OutAttribute> ByRef failures As StreamingCollection(Of Failure) _
) As CheckinResult

[WebMethodAttribute]
public CheckinResult CheckInShelveset(
    string shelvesetName,
    string ownerName,
    string changesetOwner,
    CheckinNotificationInfo checkinNotificationInfo,
    int checkinOptions,
    int maxClientPathLength,
    out StreamingCollection<Failure> conflicts,
    out StreamingCollection<Failure> failures
)

[WebMethodAttribute]
public:
CheckinResult^ CheckInShelveset(
    String^ shelvesetName, 
    String^ ownerName, 
    String^ changesetOwner, 
    CheckinNotificationInfo^ checkinNotificationInfo, 
    int checkinOptions, 
    int maxClientPathLength, 
    [OutAttribute] StreamingCollection<Failure^>^% conflicts, 
    [OutAttribute] StreamingCollection<Failure^>^% failures
)

[<WebMethodAttribute>]
member CheckInShelveset : 
        shelvesetName:string * 
        ownerName:string * 
        changesetOwner:string * 
        checkinNotificationInfo:CheckinNotificationInfo * 
        checkinOptions:int * 
        maxClientPathLength:int * 
        conflicts:StreamingCollection<Failure> byref * 
        failures:StreamingCollection<Failure> byref -> CheckinResult

public function CheckInShelveset(
    shelvesetName : String, 
    ownerName : String, 
    changesetOwner : String, 
    checkinNotificationInfo : CheckinNotificationInfo, 
    checkinOptions : int, 
    maxClientPathLength : int, 
    conflicts : StreamingCollection<Failure>, 
    failures : StreamingCollection<Failure>
) : CheckinResult

Parameters

• shelvesetName
  Type: System.String

  The name of the shelveset to submit.

• ownerName
  Type: System.String

  The owner of the shelveset.

• changesetOwner
  Type: System.String

  The author for the changeset.

• checkinNotificationInfo
  Type: Microsoft.TeamFoundation.VersionControl.Server.CheckinNotificationInfo

  The information needed by the checkin notification service.

• checkinOptions
  Type: System.Int32

  Options to control validation.

• maxClientPathLength
  Type: System.Int32

  The maximum client supported server path length.

• conflicts
  Type: Microsoft.TeamFoundation.Framework.Server.StreamingCollection<Failure>%

  The list of conflicts which occured while trying to checkin.

• failures
  Type: Microsoft.TeamFoundation.Framework.Server.StreamingCollection<Failure>%

  The list of errors and warnings which occured while trying to checkin.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Server.CheckinResult
The checkin result with the changeset created and the undone changes.

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

See Also

Reference

Repository5 Class

Microsoft.TeamFoundation.VersionControl.Server Namespace