IStillImageW::EnableHwNotifications method (sti.h)

Article
02/22/2024

The IStillImage::EnableHwNotifications method requests the still image event monitor to enable or disable the notification of applications when Still Image Device Events occur for a specified device.

Syntax

HRESULT EnableHwNotifications(
  [in] LPCWSTR pwszDeviceName,
       BOOL    bNewState
);

Parameters

[in] pwszDeviceName

Caller-supplied pointer to a string representing an internal device name, obtained by calling IStillImage::GetSTILaunchInformation or IStillImage::GetDeviceList.

bNewState

Caller-supplied value, set to TRUE to enable notifications and FALSE to disable them.

Return value

If the operation succeeds, the method returns S_OK. Otherwise, it returns one of the STIERR-prefixed error codes defined in stierr.h.

Remarks

The IStillImage::EnableHwNotifications method enables or disables notifications of still image device events for all applications, not just for the calling application. Event notifications are enabled by default. This method is meant for use by applications that intercept events from devices and reroute them.

Before calling IStillImage::EnableHwNotifications, clients of the IStillImage COM interface must call IStillImage::StiCreateInstance to obtain an IStillImage interface pointer.

Requirements

Requirement	Value
Target Platform	Desktop
Header	sti.h (include Sti.h)