IStillImageW::GetHwNotificationState method (sti.h)

Article
02/22/2024

The IStillImage::GetHwNotificationState method indicates whether applications will be notified when Still Image Device Events occur on a specified device.

Syntax

HRESULT GetHwNotificationState(
  [in]  LPCWSTR pwszDeviceName,
  [out] BOOL    *pbCurrentState
);

Parameters

[in] pwszDeviceName

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

[out] pbCurrentState

Receives TRUE if event notification is enabled, or FALSE otherwise.

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

Before calling IStillImage::GetHwNotificationState, 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)