Engine::SetProgressUpdate method

Specifies the native interface for the Engine to invoke to notify the solution of a progress update event.

Syntax

virtual HRESULT SetProgressUpdate(
  [in, optional] IProgressUpdateEventHandler *progressUpdate
) = 0;

Parameters

progressUpdate [in, optional]

The native interface invoked by Engine when an progress update event occurs. This parameter can be NULL to remove an existing handler.

Return value

If successful, the method returns S_OK.

If a job is running, the method returns AXE_E_JOB_RUNNING. Event handlers cannot be changed while a job is running.

If a there are events already queued with the Asynchronous Procedure Call mechanism in the operating system, the method returns AXE_E_QUEUED_APC_EVENTS. The threading model cannot be changed until these queued events are processed.

Remarks

Managed code uses the Engine.ProgressUpdate | progressupdate event.

Requirements

See also

Engine

OnProgressUpdate