IWDFIoRequest2::GetCreateParametersEx メソッド (wudfddi.h)

  • [アーティクル]

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

GetCreateParametersEx メソッドは、作成または開いているファイルに関連付けられているファイル作成パラメーターを取得します。

構文

void GetCreateParametersEx(
  [out, optional] ULONG       *pOptions,
  [out, optional] USHORT      *pFileAttributes,
  [out, optional] USHORT      *pShareAccess,
  [out, optional] ACCESS_MASK *pDesiredAccess
);

パラメーター

[out, optional] pOptions

ファイル作成オプションを示すビット フラグを受け取る呼び出し元によって割り当てられた変数へのポインター。 これらのFILE_XXXX名前付きビット フラグは Wdm.h で定義されています。

変数の下位 24 ビットは、ファイルを作成または開くときに適用するオプションを示します。 これらのビットの詳細については、カーネル モードの ZwCreateFile 関数の CreateOptions パラメーターの説明を参照してください。

変数の上位 8 ビットは、ファイルが存在する場合、またはまだ存在しない場合に実行するアクションを示します。 これらのビットの詳細については、ZwCreateFile の CreateDisposition パラメーターの説明を参照してください。

このパラメーターは省略可能であり、 NULL にすることができます。

[out, optional] pFileAttributes

ファイル属性を示すビット フラグを受け取る呼び出し元によって割り当てられた変数へのポインター。 これらのFILE_ATTRIBUTE_XXXX名前付きビット フラグは Wdm.h で定義されています。 これらのビット フラグの詳細については、ZwCreateFile の FileAttributes パラメーターの説明を参照してください。

このパラメーターは省略可能であり、 NULL にすることができます。

[out, optional] pShareAccess

ファイル共有オプションを示すビット フラグを受け取る呼び出し元によって割り当てられた変数へのポインター。 これらのFILE_SHARE_XXXX名前付きビット フラグは Wdm.h で定義されています。 これらのビット フラグの詳細については、ZwCreateFile の ShareAccess パラメーターの説明を参照してください。

このパラメーターは省略可能であり、 NULL にすることができます。

[out, optional] pDesiredAccess

ファイルへの要求されたアクセスを指定する呼び出し元によって割り当てられた ACCESS_MASK 構造体へのポインター。 このパラメーターの詳細については、ZwCreateFile の DesiredAccess パラメーターを参照してください。

このパラメーターは省略可能であり、 NULL にすることができます。

戻り値

なし

解説

フレームワークがドライバーの IQueueCallbackCreate::OnCreateFile コールバック関数を呼び出した後、ドライバーは IWDFIoRequest::GetCreateParameters メソッドまたは IWDFIoRequest2::GetCreateParametersEx メソッドを呼び出して、ファイルの作成パラメーターを取得できます。

詳細については、「 I/O 要求のパラメーターの取得」を参照してください。

例

次のコード例は、 IQueueCallbackCreate::OnCreateFile コールバック関数が IWDFIoRequest2 インターフェイスを取得し、 GetCreateParametersEx を呼び出す方法を示しています。

VOID
OnCreateFile(
    __in IWDFIoQueue* FxQueue,
    __in IWDFIoRequest* FxRequest,
    __in IWDFFile* FxFile
    )
{
    ULONG fileOptions;
    USHORT fileAttributes,
    USHORT shareAccess,
    ACCESS_MASK desiredAccess;
    ...
    CComQIPtr<IWDFIoRequest2> fxRequest2(FxRequest);
    fxRequest2->GetCreateParametersEx(&fileOptions
                                      &fileAttributes,
                                      &shareAccess,
                                      &desiredAccess);
    ...
}

要件

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

こちらもご覧ください

IQueueCallbackCreate::OnCreateFile

IWDFIoRequest2

IWDFIoRequest::GetCreateParameters