IStiDevice::RawWriteCommand method (sti.h)

Article
02/22/2024

The IStiDevice::RawWriteCommand method sends command information to a still image device.

Syntax

HRESULT RawWriteCommand(
  [in]           LPVOID       lpBuffer,
                 DWORD        nNumberOfBytes,
  [in, optional] LPOVERLAPPED lpOverlapped
);

Parameters

[in] lpBuffer

Caller-supplied pointer to a buffer containing data to be sent to the device.

nNumberOfBytes

Caller-supplied number of bytes to be written. This is the number of bytes in the buffer pointed to by lpBuffer.

[in, optional] lpOverlapped

Optional, caller-supplied pointer to an OVERLAPPED structure (described in the Microsoft Windows SDK documentation).

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::RawWriteCommand method calls IStiUSD::RawWriteCommand, which is exported by vendor-supplied minidrivers. The meaning of buffer contents are vendor-defined.

It is only necessary to call IStiDevice::RawWriteCommand if commands and data are written to a device by different methods. For other devices, IStiDevice::RawWriteData can be used for both commands and data.

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

Share via