IWDFIoTarget2::FormatRequestForQueryInformation メソッド (wudfddi.h)
[警告: UMDF 2 は UMDF の最新バージョンであり、UMDF 1 よりも優先されます。 すべての新しい UMDF ドライバーは、UMDF 2 を使用して記述する必要があります。 UMDF 1 には新機能が追加されておらず、新しいバージョンのWindows 10では UMDF 1 のサポートが制限されています。 ユニバーサル Windows ドライバーでは UMDF 2 を使用する必要があります。 詳細については、「UMDF を使用したはじめに」を参照してください。
FormatRequestForQueryInformation メソッドは、ファイルに関する情報を取得する I/O 要求を書式設定しますが、I/O ターゲットに要求を送信しません。
構文
HRESULT FormatRequestForQueryInformation(
[in] IWDFIoRequest *pRequest,
[in] WDF_FILE_INFORMATION_CLASS InformationClass,
[in, optional] IWDFFile *pFile,
[in, optional] IWDFMemory *pInformationMemory,
[in, optional] PWDFMEMORY_OFFSET pInformationMemoryOffset
);
パラメーター
[in] pRequest
I/O 要求を表す要求オブジェクトの IWDFIoRequest インターフェイスへのポインター。
[in] InformationClass
取得 する情報の種類を指定するWDF_FILE_INFORMATION_CLASS型指定された値。
[in, optional] pFile
I/O 要求に関連付けられているファイル オブジェクトの IWDFFile インターフェイスへのポインター。 このパラメーターは、ローカルおよびリモート の I/O ターゲットに必要であり、ファイル ハンドル I/O ターゲットの場合は省略可能です ( NULL にすることができます)。
[in, optional] pInformationMemory
メモリ オブジェクトの IWDFMemory インターフェイスへのポインター。 このオブジェクトは、 InformationClass パラメーターが指定するファイル情報を受け取る出力バッファーを表します。 このパラメーターは省略可能であり、 NULL にすることができます。
[in, optional] pInformationMemoryOffset
省略可能なバイト オフセットと長さの値を提供する WDFMEMORY_OFFSET 構造体へのポインター。 フレームワークでは、これらの値を使用して、出力バッファー内のデータ転送の開始アドレスと長さを決定します。 このポインターが NULL の場合、データ転送は出力バッファーの先頭から開始され、転送サイズはバッファー サイズです。
戻り値
FormatRequestForQueryInformation は、操作が成功した場合にS_OKを返します。 それ以外の場合、メソッドは次の値を返す可能性があります。
| リターン コード | 説明 |
|---|---|
|
フレームワークでメモリを割り当てることができませんでした。 |
このメソッドは、Winerror.h に含まれる他の値のいずれかを返す場合があります。
注釈
I/O ターゲットに要求を同期的または非同期的に送信するには、FormatRequestForQueryInformation メソッドの後に IWDFIoRequest::Send メソッドを使用します。
例
次のコード例は、 IQueueCallbackDefaultIoHandler::OnDefaultIoHandler コールバック関数の一部です。 コールバック関数は、クエリ情報要求を受信すると、デバイスの既定の I/O ターゲットに要求を送信します。
void
CMyQueue::OnDefaultIoHandler(
IWDFIoQueue* pQueue,
IWDFIoRequest* pRequest
)
{
HRESULT hr;
IWDFDevice *pDevice;
IWDFIoTarget *pTarget;
IWDFFile *pFile;
IWDFMemory *pOutMemory;
WDF_FILE_INFORMATION_CLASS infoClass;
//
// Obtain the device, default I/O target, and file object.
//
pQueue->GetDevice(&pDevice);
pDevice->GetDefaultIoTarget(&pTarget);
pRequest->GetFileObject(&pFile);
if (WdfRequestQueryInformation==pRequest->GetType())
{
//
// Declare an IWDFIoRequest2 interface pointer and obtain the
// IWDFIoRequest2 interface from the IWDFIoRequest interface.
//
CComQIPtr<IWDFIoRequest2> r2 = pRequest;
//
// Declare an IWDFIoTarget2 interface pointer and obtain the
// IWDFIoTarget2 interface from the IWDFIoTarget interface.
//
CComQIPtr<IWDFIoTarget2> target2(pTarget);
//
// Get the I/O request's output buffer.
//
hr = pWdfRequest2->RetrieveOutputMemory(&pOutMemory);
if (!SUCCEEDED(hr)) goto Error;
//
// Get the I/O request's parameters.
//
hr = pWdfRequest2->GetQueryInformationParameters(&infoClass,
NULL);
if (!SUCCEEDED(hr)) goto Error;
//
// Format a query information request and send it to the I/O target.
//
hr = target2->FormatRequestForQueryInformation(pRequest,
infoClass,
pFile,
pOutMemory,
NULL);
if (!SUCCEEDED(hr)) goto Error;
hr = pRequest->Send(pTarget,
WDF_REQUEST_SEND_OPTION_SYNCHRONOUS,
0);
}
...
Error;
//
// Release objects.
//
SAFE_RELEASE(pDevice);
SAFE_RELEASE(pTarget);
SAFE_RELEASE(pFile);
SAFE_RELEASE(pOutMemory);
}
要件
| 要件 | 値 |
|---|---|
| サポート終了 | UMDF 2.0 以降では使用できません。 |
| 対象プラットフォーム | デスクトップ |
| 最小 UMDF バージョン | 1.9 |
| Header | wudfddi.h (Wudfddi.h を含む) |
| [DLL] | WUDFx.dll |