Edit

IStiDevice::GetStatus method (sti.h)

  • Article

The IStiDevice::GetStatus method returns a still image device's status information.

Syntax

HRESULT GetStatus(
  [in, out] PSTI_DEVICE_STATUS pDevStatus
);

Parameters

[in, out] pDevStatus

Caller-supplied pointer to an STI_DEVICE_STATUS structure. The caller must set the dwSize and StatusMask members.

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 IStiDevice::GetStatus method returns device status information in the caller-supplied STI_DEVICE_STATUS structure. It obtains the status by calling IStiUSD::GetStatus, which is exported by vendor-supplied minidrivers.

Before calling IStiDevice::GetStatus, clients of the IStiDevice COM interface must call IStillImage::CreateDevice to obtain an IStiDevice interface pointer, which provides access to a specified device.

A call to IStiDevice::GetStatus must be preceded by a call to IStiDevice::LockDevice and followed by a call to IStiDevice::UnLockDevice.

Requirements

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