Метод IStiDevice::Escape (sti.h)

Метод IStiDevice::Escape отправляет запрос на операцию ввода-вывода конкретного поставщика на устройство с неподвижным образом.

Синтаксис

HRESULT Escape(
  [in]      STI_RAW_CONTROL_CODE EscapeFunction,
  [in]      LPVOID               lpInData,
            DWORD                cbInDataSize,
  [in, out] LPVOID               pOutData,
            DWORD                dwOutDataSize,
  [out]     LPDWORD              pdwActualData
);

Параметры

[in] EscapeFunction

Предоставленное вызывающим, определяемое поставщиком значение размера DWORD, представляющее операцию ввода-вывода. Мини-диск устройства должен распознавать это значение и экспортировать интерфейс IStiUSD . Значения, определяемые поставщиком, должны быть больше STI_RAW_RESERVED, которые определены в Sti.h.

[in] lpInData

Предоставленный вызывающим объектом указатель на буфер, содержащий данные для отправки на устройство.

cbInDataSize

Предоставленная вызывающим объектом длина данных, содержащихся в буфере, на который указывает lpInData, в байтах.

[in, out] pOutData

Предоставленный вызывающим объектом указатель на буфер памяти для получения данных с устройства.

dwOutDataSize

Предоставленная вызывающим объектом длина буфера, на который указывает lpOutData, в байтах.

[out] pdwActualData

Получает количество байтов, фактически записанных в pOutData.

Возвращаемое значение

Если операция выполнена успешно, метод возвращает S_OK. В противном случае возвращается один из кодов ошибок с префиксом STIERR, определенных в файле stierr.h.

Комментарии

Метод IStiDevice::Escape вызывает IStiUSD::Escape, который экспортируется предоставленными поставщиком мини-драйверами. Мини-диск устройства определяет использование параметра Method.

Перед вызовом IStiDevice::Escape клиенты com-интерфейса IStiDevice должны вызвать IStillImage::CreateDevice , чтобы получить указатель интерфейса IStiDevice , который предоставляет доступ к указанному устройству.

Перед вызовом IStiDevice::Escape должен предшествовать вызов IStiDevice::LockDevice , а затем вызов IStiDevice::UnLockDevice.

Требования

Требование	Значение
Целевая платформа	Персональный компьютер
Верхняя часть	sti.h (включая Sti.h)