IStiDevice::Escape メソッド (sti.h)

IStiDevice::Escape メソッドは、ベンダー固有の I/O 操作の要求を静止画像デバイスに送信します。

構文

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

パラメーター

[in] EscapeFunction

I/O 操作を表す呼び出し元指定のベンダー定義の DWORD サイズの値。 デバイスのミニドライバーは、この値を認識し、 IStiUSD インターフェイスをエクスポートする必要があります。 ベンダー定義の値は、 Sti.h で定義されているSTI_RAW_RESERVEDより大きくする必要があります。

[in] lpInData

デバイスに送信されるデータを含むバッファーへの呼び出し元指定ポインター。

cbInDataSize

lpInData が指すバッファーに含まれるデータの呼び出し元から指定された長さ (バイト単位)。

[in, out] pOutData

デバイスからデータを受信するためのメモリ バッファーへの呼び出し元指定ポインター。

dwOutDataSize

lpOutData が指すバッファーの呼び出し元から指定された長さ (バイト単位)。

[out] pdwActualData

pOutData に実際に書き込まれたバイト数を受け取ります。

戻り値

操作が成功した場合、メソッドは S_OKを返します。 それ以外の場合は、 stierr.h で定義されている STIERR プレフィックス付きのエラー コードのいずれかを返します。

注釈

IStiDevice::Escape メソッドは、ベンダー提供のミニドライバーによってエクスポートされる IStiUSD::Escape を呼び出します。 デバイスのミニドライバーは、メソッド パラメーターの使用法を定義します。

IStiDevice::Escape を呼び出す前に、IStiDevice COM インターフェイスのクライアントは IStillImage::CreateDevice を呼び出して、指定されたデバイスへのアクセスを提供する IStiDevice インターフェイス ポインターを取得する必要があります。

IStiDevice::Escape の呼び出しの前に IStiDevice::LockDevice を呼び出し、その後に IStiDevice::UnLockDevice を呼び出す必要があります。

要件

要件	値
対象プラットフォーム	デスクトップ
Header	sti.h (Sti.h を含む)