Workspace.EvaluateCheckin Method

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

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

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

Parameters

options
Type: Microsoft.TeamFoundation.VersionControl.Client.CheckinEvaluationOptions

One or more of the enum values (Notes, Policies, Conflicts, or All) as options for the check-in evaluation.

allChanges
Type: Microsoft.TeamFoundation.VersionControl.Client.PendingChange[]

The complete set of pending changes for the workspace. If you do not specify this parameter, all pending changes are evaluated.

changes
Type: 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

One or more check-in notes.

workItemChanges
Type: Microsoft.TeamFoundation.VersionControl.Client.WorkItemCheckinInfo[]

The work items that are associated with this check-in.

Return Value

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

Show: