Partager via


Engine::SetJobBegin method

Specifies the native interface for the Engine to invoke to notify the solution of a job begin event.

Syntax

virtual HRESULT SetJobBegin(
  [in, optional] IJobBeginEventHandler *jobBegin
) = 0;

Parameters

jobBegin [in, optional]

The native interface invoked by Engine when a job begin 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.JobBegin | jobbegin event.

Requirements

Minimum supported client
Windows 7 [desktop apps only]
Minimum supported server
Windows Server 2008 R2 [desktop apps only]
Header
AxeHosting.h
DLL
AxeCore.dll

See also

Engine

IJobBeginEventHandler

OnJobBegin