II3IDStepEvents::StepOutOfSync Method

Synopsis

This method is called when inconsistencies are found between the registered tool and the data stored in the .IHD file.

HRESULT StepOutOfSync(

[in] I3IDOutOfSyncReason ReasonCode,

[in] II3IDStep * CurrentStep,

[in] II3IDOldStepInfo * OutOfSyncInfo,

[out, retval] VARIANT_BOOL * BeenHandled

);

HRESULT StepOutOfSync(I3IDOutOfSyncReason ReasonCode, II3IDStep * CurrentStep, II3IDOldStepInfo * OutOfSyncInfo, VARIANT_BOOL * BeenHandled );

ReasonCode: An I3IDOutOfSyncReason reason code that indicates which part of the step is not in sync with the currently registered tool.
CurrentStep: The II3IDStep step object that is out of synch.
OutOfSyncInfo: This object indicates how the step looked when it was in synch with the currently registered tool.
BeenHandled: The return value is a Boolean flag that indicates whether or not the callback that has been called by Interaction Designer has handled this event. The callback sets BeenHandled to True if the callback has handled the parameter migration for that step. This tells Interaction Designer not to perform its generic parameter migration functions. Likewise, if the callback did not handle the parameter migration, it sets the value of BeenHandled to False so that Interaction Designer will perform its generic parameter migration functions.