IStiDevice::Escape-Methode (sti.h)

Artikel
02/07/2025

Die IStiDevice::Escape-Methode sendet eine Anforderung für einen herstellerspezifischen E/A-Vorgang an ein Stillbildgerä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-Größenwert, 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, die in Sti.hdefiniert 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 im Puffer enthaltenen Daten in Bytes, auf die durch lpInData-verwiesen wurde.

[in, out] pOutData

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

dwOutDataSize

Vom Aufrufer bereitgestellte Länge (in Byte) des Puffers, auf den lpOutDataverweist.

[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 eine der STIERR-Präfixfehlercodes zurückgegeben, die in stierr.hdefiniert sind.

Bemerkungen

Die IStiDevice::Escape-Methode ruft IStiUSD::Escapeauf, die von einem Hersteller bereitgestellten Minidriver exportiert wird. Der Minidriver des Geräts definiert die Methodenparameterverwendung.

Vor dem Aufrufen IStiDevice::Escapemüssen Clients der IStiDevice- COM-Schnittstelle IStillImage::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 vorangestellt werden, gefolgt von einem Aufruf von IStiDevice::UnLockDevice.

Anforderungen

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

Freigeben über