Edit

IStiUSD::GetStatus method (stiusd.h)

  • Article

A still image minidriver's IStiUSD::GetStatus method returns the status of a still image device.

Syntax

HRESULT GetStatus(
  PSTI_DEVICE_STATUS pDevStatus
);

Parameters

pDevStatus

Caller-supplied pointer to an STI_DEVICE_STATUS structure.

Return value

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

Remarks

The caller supplies values for the dwSize and StatusMask members of the STI_DEVICE_STATUS structure, and the minidriver must supply values for the rest of the structure members.

If the driver has previously set the STI_GENCAP_POLLING_NEEDED flag in the device's STI_DEV_CAPS structure, the minidriver's IStiUSD::GetStatus method is the means by which the event monitor determines if a Still Image Device Events has occurred. The event monitor will call the method, specifying STI_DEVSTATUS_EVENT_STATE in the supplied STI_DEVICE_STATUS structure. The driver must poll the device and set STI_EVENTHANDLING_PENDING if an event has occurred.

If the caller specifies STI_DEVSTATUS_ONLINE_STATE in the supplied STI_DEVICE_STATUS structure, the minidriver should set the appropriate flag in the structure's dwOnlineState member.

Requirements

Requirement Value
Target Platform Desktop
Header stiusd.h (include Stiusd.h)

See also

IStiDevice::GetStatus

IStiUSD