Workspace.EvaluateCheckin Method

Evaluates the pending changes to verify they are ready for check-in.

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

Syntax

'Declaration
Public Function EvaluateCheckin ( _
    options As CheckinEvaluationOptions, _
    allChanges As PendingChange(), _
    changes As PendingChange(), _
    comment As String, _
    checkinNote As CheckinNote, _
    workItemChanges As WorkItemCheckinInfo() _
) As CheckinEvaluationResult

public CheckinEvaluationResult EvaluateCheckin(
    CheckinEvaluationOptions options,
    PendingChange[] allChanges,
    PendingChange[] changes,
    string comment,
    CheckinNote checkinNote,
    WorkItemCheckinInfo[] workItemChanges
)

public:
CheckinEvaluationResult^ EvaluateCheckin(
    CheckinEvaluationOptions options, 
    array<PendingChange^>^ allChanges, 
    array<PendingChange^>^ changes, 
    String^ comment, 
    CheckinNote^ checkinNote, 
    array<WorkItemCheckinInfo^>^ workItemChanges
)

member EvaluateCheckin : 
        options:CheckinEvaluationOptions * 
        allChanges:PendingChange[] * 
        changes:PendingChange[] * 
        comment:string * 
        checkinNote:CheckinNote * 
        workItemChanges:WorkItemCheckinInfo[] -> CheckinEvaluationResult 

public function EvaluateCheckin(
    options : CheckinEvaluationOptions, 
    allChanges : PendingChange[], 
    changes : PendingChange[], 
    comment : String, 
    checkinNote : CheckinNote, 
    workItemChanges : WorkItemCheckinInfo[]
) : CheckinEvaluationResult

Parameters

• options
  Type: Microsoft.TeamFoundation.VersionControl.Client.CheckinEvaluationOptions
  Options for the check-in evaluation.

• allChanges
  Type: array<Microsoft.TeamFoundation.VersionControl.Client.PendingChange[]
  The entire set of pending changes for the workspace. Null to automatically get this list.

• changes
  Type: array<Microsoft.TeamFoundation.VersionControl.Client.PendingChange[]
  The candidate changes for evaluation.

• comment
  Type: System.String
  Check-in comment for validation

• checkinNote
  Type: Microsoft.TeamFoundation.VersionControl.Client.CheckinNote
  Check-in notes.

• workItemChanges
  Type: array<Microsoft.TeamFoundation.VersionControl.Client.WorkItemCheckinInfo[]
  Associated work items for this check-in.

Return Value

Type: Microsoft.TeamFoundation.VersionControl.Client.CheckinEvaluationResult
The result of the evaluation.

.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

Workspace Class

Microsoft.TeamFoundation.VersionControl.Client Namespace