IStiDevice::Escape-Methode (sti.h)

  • Artikel

Die IStiDevice::Escape-Methode sendet eine Anforderung für einen herstellerspezifischen E/A-Vorgang an ein Standbildgerät.

Syntax

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

Parameter

[in] EscapeFunction

Vom Aufrufer bereitgestellter, vom Anbieter definierter DWORD-Wert, der einen E/A-Vorgang darstellt. Der Minidriver des Geräts muss diesen Wert erkennen und eine IStiUSD-Schnittstelle exportieren. Vom Anbieter definierte Werte müssen größer als STI_RAW_RESERVED sein, der in Sti.h definiert ist.

[in] lpInData

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

cbInDataSize

Die vom Aufrufer bereitgestellte Länge der Daten im Puffer, auf den lpInData verweist, in Bytes.

[in, out] pOutData

Vom Aufrufer bereitgestellter Zeiger auf einen Speicherpuffer zum Empfangen von Daten vom Gerät.

dwOutDataSize

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

[out] pdwActualData

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

Rückgabewert

Wenn der Vorgang erfolgreich ist, gibt die Methode S_OK zurück. Andernfalls wird einer der in stierr.h definierten Fehlercodes mit STIERR-Präfix zurückgegeben.

Hinweise

Die IStiDevice::Escape-Methode ruft IStiUSD::Escape auf, das von vom Anbieter bereitgestellten Minitreibern exportiert wird. Der Minidriver des Geräts definiert die Verwendung des Method-Parameters.

Vor dem Aufrufen von IStiDevice::Escape müssen Clients der IStiDevice-COM-SchnittstelleIStillImage::CreateDevice aufrufen, um einen IStiDevice-Schnittstellenzeiger abzurufen, der Zugriff auf ein angegebenes Gerät ermöglicht.

Einem Aufruf von IStiDevice::Escape muss ein Aufruf von IStiDevice::LockDevice und gefolgt von einem Aufruf von IStiDevice::UnLockDevice vorangestellt werden.

Anforderungen

Anforderung Wert
Zielplattform Desktop
Kopfzeile sti.h (einschließlich Sti.h)