Edit

IStiDevice::Diagnostic method (sti.h)

  • Article

The IStiDevice::Diagnostic method executes diagnostic tests on a still image device.

Syntax

HRESULT Diagnostic(
  [in, out] LPSTI_DIAG pBuffer
);

Parameters

[in, out] pBuffer

Caller-supplied pointer to an STI_DIAG structure specifying the type of tests to be run. On return, the structure contains status information.

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::Diagnostic method calls IStiUSD::Diagnostic, which is exported by vendor-supplied minidrivers. The Scanners and Cameras Control Panel calls IStiDevice::Diagnostic when a user presses the Test button.

Before calling IStiDevice::Diagnostic, 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::Diagnostic 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)