IWDFIoRequest2::RetrieveInputBuffer メソッド (wudfddi.h)
[警告: UMDF 2 は UMDF の最新バージョンであり、UMDF 1 よりも優先されます。 すべての新しい UMDF ドライバーは、UMDF 2 を使用して記述する必要があります。 UMDF 1 には新機能が追加されておらず、Windows 10 の新しいバージョンでは UMDF 1 のサポートが制限されています。 ユニバーサル Windows ドライバーでは、UMDF 2 を使用する必要があります。 詳細については、「UMDFの概要」を参照してください。
RequestRetrieveInputBuffer メソッドは、I/O 要求の入力バッファーを取得します。
構文
HRESULT RetrieveInputBuffer(
[in] SIZE_T MinimumRequiredCb,
[out] PVOID *Buffer,
[out, optional] SIZE_T *BufferCb
);
パラメーター
[in] MinimumRequiredCb
ドライバーが I/O 要求を処理するために必要な最小バッファー サイズ (バイト単位)。 最小バッファー サイズがない場合、この値は 0 にすることができます。
[out] Buffer
バッファーのアドレスを受け取る場所へのポインター。
[out, optional] BufferCb
バッファーのサイズを受け取る場所へのポインター (バイト単位)。 このパラメーターは省略可能であり、NULL できます。
戻り値
RequestRetrieveInputBuffer 、操作が成功した場合にS_OKを返します。 それ以外の場合、このメソッドは次の値を返すことができます。
リターン コード | 形容 |
---|---|
|
I/O 要求で入力バッファーが提供されなかったか、入力バッファーのサイズが、MinimumRequiredCb が指定 最小サイズより小さい。 |
|
バッファーを取得するのに十分なメモリがありません。 ドライバーは、エラー状態の値で要求を完了する必要があります。 |
このメソッドは、Winerror.h に含まれる他の値の 1 つを返す場合があります。
備考
要求の入力バッファーには、ディスクに書き込まれるデータなど、要求の発信元が指定した情報が含まれます。 ドライバーは、RequestRetrieveInputBuffer を呼び出して、書き込み要求またはデバイス I/O 制御要求の入力バッファーを取得できますが、読み取り要求では取得できません (読み取り要求では入力データが提供されないため)。
RequestRetrieveInputBuffer メソッドは、バッファーに格納された I/O を使用する I/O 要求の入力バッファーを取得するか、データ バッファーにアクセスするためのダイレクト I/O メソッド 取得します。
RequestRetrieveInputBuffer S_OKを返す場合、ドライバーはアドレスと、必要に応じて入力バッファーのサイズを受け取ります。
ドライバーは、が I/O 要求 完了するまで、取得したバッファーにアクセスできます。
RequestRetrieveInputBufferを呼び出す代わりに、ドライバーは IWDFIoRequest2::RetrieveInputMemory を呼び出すことができます。これによって、バッファーを表すフレームワーク メモリ オブジェクトが作成されます。
I/O 要求のデータ バッファーへのアクセスの詳細については、「UMDF-Based ドライバー でのデータ バッファーへのアクセス」を参照してください。
例
次のコード例は、シリアル ポート ドライバーの IQueueCallbackDeviceIoControl::OnDeviceIoControl コールバック関数のセグメントを示しています。 I/O 要求の入力バッファーから、コード セグメントはデバイスに設定するボー レートを取得します。
VOID
STDMETHODCALLTYPE
CMyQueue::OnDeviceIoControl(
__in IWDFIoQueue* FxQueue,
__in IWDFIoRequest* FxRequest,
__in ULONG ControlCode,
__in SIZE_T InputBufferCb,
__in SIZE_T OutputBufferCb
)
{
PBYTE buffer;
SIZE_T bufferSize;
HRESULT hr;
//
// Declare an IWDFIoRequest2 interface pointer and obtain the
// IWDFIoRequest2 interface from the IWDFIoRequest interface.
//
CComQIPtr<IWDFIoRequest2> r2 = FxRequest;
switch (ControlCode)
{
case IOCTL_SERIAL_SET_BAUD_RATE:
{
//
// Obtain the baud rate from the write request's input buffer.
//
hr = r2->RetrieveInputBuffer(sizeof(SERIAL_BAUD_RATE),
(PVOID*) &buffer,
&bufferSize);
...
}
}
}
必要条件
要件 | 価値 |
---|---|
サポート終了 | UMDF 2.0 以降では使用できません。 |
ターゲット プラットフォーム の | デスクトップ |
UMDF の最小バージョン を する | 1.9 |
ヘッダー | wudfddi.h (Wudfddi.h を含む) |
DLL | WUDFx.dll |
関連項目
IWDFIoRequest2 の
IWDFIoRequest2::RetrieveInputMemory
IWDFIoRequest2::RetrieveOutputBuffer