IStiUSD::Escape-Methode (stiusd.h)

Die IStiUSD::Escape-Methode eines Standbildminidrivers führt einen herstellerspezifischen E/A-Vorgang auf einem Standbildgerät aus.

Syntax

HRESULT Escape(
  STI_RAW_CONTROL_CODE EscapeFunction,
  LPVOID               lpInData,
  DWORD                cbInDataSize,
  LPVOID               pOutData,
  DWORD                cbOutDataSize,
  LPDWORD              pdwActualData
);

Parameter

EscapeFunction

Vom Aufrufer bereitgestellter, vom Anbieter definierter Wert in DWORD-Größe, der einen E/A-Vorgang darstellt. Vom Anbieter definierte Werte müssen größer als STI_RAW_RESERVED sein, der in Sti.h definiert ist.

lpInData

Vom Aufrufer bereitgestellter Zeiger auf einen Puffer, der Daten enthält, die an das Gerät gesendet werden.

cbInDataSize

Vom Aufrufer bereitgestellte Länge des Puffers, auf den lpInData verweist, in Bytes.

pOutData

Vom Aufrufer bereitgestellter Zeiger auf einen Speicherpuffer, um Daten vom Gerät zu empfangen.

cbOutDataSize

Vom Aufrufer bereitgestellte Länge des Puffers, auf den lpOutData verweist, in Bytes.

pdwActualData

Empfängt die Anzahl der Bytes, die tatsächlich in pOutData geschrieben wurden.

Rückgabewert

Wenn der Vorgang erfolgreich ist, sollte die Methode S_OK zurückgeben. Andernfalls sollte einer der in stierr.h definierten Fehlercodes mit STIERR-Präfix zurückgegeben werden. Wenn die Methode nicht implementiert ist, sollte sie STIERR_UNSUPPORTED zurückgeben.

Hinweise

Ein Standbildminidriver muss IStiUSD::Escape nur implementieren, wenn E/A-Vorgänge erforderlich sind, die nicht in den Methoden IStiUSD::RawReadData, IStiUSD::RawWriteData, IStiUSD::RawReadCommand oder IStiUSD::RawWriteCommand implementiert werden können. Der Minidriver definiert die Parameterverwendung für IStiUSD::Escape.

Anforderungen

Weitere Informationen

IStiDevice::Escape

IStiUSD