WdfRequestGetFileObject 関数 (wdfrequest.h)

[KMDF と UMDF に適用]

WdfRequestGetFileObject メソッドは、指定された I/O 要求に関連付けられているフレームワーク ファイル オブジェクトを取得します。

構文

WDFFILEOBJECT WdfRequestGetFileObject(
  [in] WDFREQUEST Request
);

パラメーター

[in] Request

フレームワーク要求オブジェクトへのハンドル。

戻り値

WdfRequestGetFileObject は、フレームワークが指定された要求のファイル オブジェクトを作成した場合、フレームワーク ファイル オブジェクトへのハンドルを返します。 それ以外の場合、このメソッドは NULL 返します。 (通常、ドライバーは、WDF_FILEOBJECT_CONFIG 構造体で WdfFileObjectCanBeOptional ビット フラグを設定した場合にのみ、NULL 戻り値をテストします。

ドライバーが無効なオブジェクト ハンドルを提供すると、バグ チェックが発生します。

備考

WdfRequestGetFileObject メソッドは、次のいずれかの場合 NULL を返します。

• ドライバーが WdfDeviceInitSetFileObjectConfig 呼び出されておらず、フレームワークがファイル オブジェクトを作成する WDF_FILEOBJECT_CLASS 値を指定しました。
• 別のドライバーは、最初に WdfRequestTypeCreate の要求の種類を送信せずに、読み取り、書き込み、または I/O 制御要求ドライバーに送信しました。

WdfRequestGetFileObject およびフレームワーク ファイル オブジェクト の詳細については、「Framework ファイル オブジェクト」を参照してください。

例

次のコード例では、I/O 要求のファイル オブジェクトを取得し、ファイル オブジェクトのコンテキスト空間へのポインターを取得するドライバー定義ルーチンを呼び出します。

VOID
MyEvtIoWrite(
    IN WDFQUEUE  Queue,
    IN WDFREQUEST  Request,
    IN size_t  Length
    )
{
    WDFFILEOBJECT  fileObject;
    PFILE_OPEN_CONTEXT  pOpenContext;

    fileObject = WdfRequestGetFileObject(Request);
    pOpenContext = GetFileObjectContext(fileObject)->OpenContext;
}

必要条件

要件	価値
ターゲット プラットフォーム の	万国
最小 KMDF バージョン	1.0
UMDF の最小バージョン を する	2.0
ヘッダー	wdfrequest.h (Wdf.h を含む)
ライブラリ	Wdf01000.sys (KMDF);WUDFx02000.dll (UMDF)
IRQL	<=DISPATCH_LEVEL
DDI コンプライアンス規則 を する	DriverCreate(kmdf), FileObjectConfigured(kmdf), InvalidReqAccess(kmdf), InvalidReqAccessLocal(kmdf), KmdfIrql(kmdf), KmdfIrql2(kmdf), KmdfIrqlExplicit(kmdf)

関連項目

WDF_FILEOBJECT_CLASS

WdfDeviceInitSetFileObjectConfig の