Edit

Share via

IRunActionRequest::RequestAsync method

  • Article

An asynchronous request to initiate an action (for example, capture a frame) in the engine.

Syntax

HRESULT RequestAsync(
   REFGUID              action,
   IUnknown *           actionPayload,
   IRunActionCallback * requestCallback,
   DWORD                requestCookie,
   DWORD                progressIntervalMsecs
);

Parameters

action
The specified action.

actionPayload
The payload of the specified action.

requestCallback
The address of callback used to notify the host of results.

requestCookie
A cookie that uniquely identifies the request, and can be used to signal for it to be cancelled.

progressIntervalMsecs
Not used.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Requirements

Header

Vspixengine.h

See also

IRunActionRequest