LIBDF Structures: TDfChangePhase

Summary

 

Pointer on the structure TDfChangePhase is passed as the only parameter of the callback-function of process phase change notification.

 

Syntax

 

struct TDfChangePhase

{

EnDfPhase

enPhase;

int

bBegin;

void  *

lpPhaseData;

void  *

lpUserData;

};

 

Fields

 

enPhase – execution phase identifier (ID). Currently the following phases are defined:

 

Phase ID

Description

Function, which can use it

eaphContentCmp

File content comparing

dfCompare

eaphOldMD5

Calculating of old file's MD5

dfBuildN, dfBuildH

eaphNewMD5

Calculating of new file's MD5

dfBuildN, dfBuildH

eaphGenDf

df-file building

dfBuildN, dfBuildH

eaphApplyDf

df-file applying

dfApplyN, dfApplyH

 

bBegin – flag of beginning/ending of the phase execution.

Possible values:

"1" – phase beginning;

"0" – phase ending.

For each phase executed a callback-function OnDfChangePhase will be called 2 times: before phase beginning and after phase ending.

Notification of phase changing is called in such a way that two different phases cannot cross by time, i.e. if a notification of the 1st phase beginning comes then a notification of its ending will be called before a notification of the 2nd phase beginning comes.

 

lpPhaseData – pointer on additional data concerned with the current phase.

Currently the value of lpPhaseData is defined only for eaphOldMD5 and eaphNewMD5 phases: at their completion (bBegin is "0") the field lpPhaseData points on the calculated value of MD5 of an old and new file accordingly. In other cases field lpPhaseData contains NULL.

 

lpUserData – value passed to the field lpUserData of TDfInteract structure.

Can be used by application on its own.

 

Converted from CHM to HTML with chm2web Standard 2.75 (unicode)