IWDFIoRequest::GetReadParameters メソッド (wudfddi.h)

警告

UMDF 2 は UMDF の最新バージョンであり、UMDF 1 よりも優先されます。 すべての新しい UMDF ドライバーは、UMDF 2 を使用して記述する必要があります。 UMDF 1 には新機能が追加されておらず、新しいバージョンのWindows 10では UMDF 1 のサポートが制限されています。 ユニバーサル Windows ドライバーでは UMDF 2 を使用する必要があります。 詳細については、「UMDF を使用したはじめに」を参照してください。

GetReadParameters メソッドは、読み取り型要求の要求パラメーターを取得します。

構文

void GetReadParameters(
  [out, optional] SIZE_T   *pSizeInBytes,
  [out, optional] LONGLONG *pullOffset,
  [out, optional] ULONG    *pulKey
);

パラメーター

[out, optional] pSizeInBytes

読み取るサイズをバイト単位で受け取る変数へのポインター。 読み取り用のデータを取得するために、ドライバーは IWDFIoRequest::GetOutputMemory メソッドを呼び出します。

このパラメーターは省略可能です。 ドライバーは、情報を必要としない場合に NULL を 渡すことができます。

[out, optional] pullOffset

デバイスまたはデバイス上のファイルからの読み取りを開始するためのオフセットをバイト単位で受け取る変数へのポインター。 デバイスが絶対読み取りアドレスをサポートしていない場合は、 pullOffset を無視できます。 詳細については、「解説」を参照してください。

クライアント アプリケーションは、OVERLAPPED 構造体の Offset メンバーと OffsetHigh メンバーでこの値を指定します。 OVERLAPPED へのポインターは、Microsoft Win32 ReadFile 関数または ReadFileEx 関数で渡されます。

このパラメーターは省略可能です。 ドライバーは、情報を必要としない場合に NULL を 渡すことができます。

[out, optional] pulKey

ドライバーが決定する方法で I/O 要求を並べ替えるためにドライバーが使用できるキーを受け取る変数へのポインター。

このパラメーターは省略可能です。 ドライバーは、情報を必要としない場合に NULL を 渡すことができます。

戻り値

なし

解説

要求の種類が読み取り型でない場合、 GetReadParameters の呼び出しは失敗します。

アドレス指定をサポートするデバイス (ディスク デバイスなど) の場合、 pullOffset パラメーターが指す値は通常、デバイスへのバイト オフセットです。 アドレス指定をサポートしていないデバイス (シリアル ポートなど) の場合、ドライバーは pullOffset の値を無視できます。

ドライバーは、必要に応じて pSizeInBytes、pullOffset、および pulKey の各パラメーターに NULL を指定できますが、GetReadParameters を正常に実行するには、少なくとも 1 つの NULL 以外のパラメーターを指定する必要があります。

要件

要件	値
サポート終了	UMDF 2.0 以降では使用できません。
対象プラットフォーム	デスクトップ
最小 UMDF バージョン	1.5
Header	wudfddi.h (Wudfddi.h を含む)
[DLL]	WUDFx.dll

こちらもご覧ください

• IWDFIoRequest
• IWDFIoRequest::GetOutputMemory