LPEVALCOMCALLBACK callback function (evalcom2.h)

Article
10/13/2021

The LPEVALCOMCALLBACK specification defines a callback function prototype. The IValidate::SetStatus method enables an authoring tool to receive information about the progress of validation through the registered callback function.

Syntax

LPEVALCOMCALLBACK Lpevalcomcallback;

BOOL Lpevalcomcallback(
  [in] STATUSTYPES iStatus,
       LPCWSTR szData,
       LPVOID pContext
)
{...}

Parameters

[in] iStatus

Specifies the status message sent by evalcom2.

Value	Meaning
NULL	The value of this param
ieStatusICECount 1	Number of ICEs that are being run.
ieStatusMerge 2	Merging the package or merge module with the .cub file.
ieStatusSummaryInfo 3	Merging summary information streams.
ieStatusCreateEngine 4	Preparing to run the ICEs.
ieStatusRunICE 5	Running an individual ICE.
ieStatusStarting 6	Starting validation.
ieStatusShutdown 7	Finish running the ICEs.
ieStatusSuccess 8	Validation completed successfully.
ieStatusFail 9	Validation failed.
ieStatusCancel 10	Validation was canceled.

szData

A string value containing information appropriate to the status. The value of szwData should be the number of ICEs that are being run if iStatus is ieStatusICECount. The value of szwData should be the name of the ICE being run if iStatus is ieStatusRunICE. Otherwise, the value of szwData should be NULL. The callback function should accept NULL as a possible value for this parameter.

pContext

Pointer to an application context passed to the SetStatus method. This parameter can be used for error checking.

Return value

Return code/value	Description
TRUE 1	Validation procedure should continue.
FALSE 0	Validation was canceled. The callback function return FALSE to stop validation.

Remarks

The SetStatus method and LPEVALCOMCALLBACK can be used to provide progress information. For example, the ieStatusICECount message can provide the overall tick count for a progress bar. For each ieStatusRunICE message received, the caller can increment the progress bar one tick.

Requirements

Requirement	Value
Minimum supported client	Evalcom2.dll version 3.0.3790.371 or later
Target Platform	Windows
Header	evalcom2.h