IWDFFile::RetrieveFileName メソッド (wudfddi.h)

  • [アーティクル]

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

RetrieveFileName メソッドは、基になるカーネル モード デバイスに関連付けられているファイルの完全な名前を取得します。

構文

HRESULT RetrieveFileName(
  [out]     PWSTR pFileName,
  [in, out] DWORD *pdwFileNameLengthInChars
);

パラメーター

[out] pFileName

指定されたポインターが NULL 以外で RetrieveFileName が成功した場合に、基になるカーネル モード デバイスに関連付けられているファイルの完全な名前を表す NULL で終わる文字列を受け取る呼び出し元が指定したバッファーへのポインター。

[in, out] pdwFileNameLengthInChars

pFileName が指す完全なファイル名のサイズ (文字数) を受け取る呼び出し元が指定した変数へのポインター。 pFileName のバッファーが NULL 以外の場合、フレームワークはファイル名文字列のサイズを文字数で返します。

入力時に、ドライバーは pFileName が指すバッファーのサイズ (文字単位) にこの変数を設定します。 ドライバーが pFileName に NULL を指定し、pdwFileNameLengthInChars が指す変数に 0 を指定した場合、フレームワークは変数をファイル名文字列に必要なサイズ (文字数) に設定します。

戻り値

RetrieveFileName は、次のシナリオのS_OKを返します。

  • pFileName パラメーターが指すバッファーは NULL 以外で、NULL 文字を含む名前文字列を保持するのに十分な大きさであり、フレームワークは指定されたバッファーに文字列を正常にコピーし、pdwFileNameLengthInChars パラメーターが指す変数を文字列内の文字数に設定しました。
  • pFileName のバッファーは NULL で、ドライバーは pdwFileNameLengthInChars の変数を 0 に事前設定し、フレームワークは pdwFileNameLengthInChars の変数を文字列に必要な文字数に設定しました。
RetrieveFileName は、指定されたバッファーが NULL 以外であり、ファイル名を保持するのに十分な領域が含まれていないことを示すHRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) を返します。 フレームワークは 、pdwFileNameLengthInChars の変数を、文字列に必要な文字数に設定します。

RetrieveFileName は、他の HRESULT 値も返す場合があります。

注釈

ドライバーは、IQueueCallbackCreate::OnCreateFile コールバック関数から RetrieveFileName を呼び出す場合があります。 詳細については、「 UMDF ドライバーでのデバイス インターフェイスの使用」を参照してください。

例

次のコード例は、ファイルの名前を取得する方法を示しています。

    ULONG fileNameCch = 0;
    PWSTR fileName = NULL;
    ULONG index;

    CComObject<CUmdfHidFile> *file = NULL;

    HRESULT hr;

    // Get the length of the file name to allocate a buffer.
    hr = WdfFile->RetrieveFileName(NULL, &fileNameCch);
    //
    // Allocate the buffer.
    //
    if (SUCCEEDED(hr))
    {
        fileName = new WCHAR[fileNameCch];

        if (fileName == NULL)
        {
            hr = E_OUTOFMEMORY;
        }
    }
    //
    // Get the file name.
    //
    if (SUCCEEDED(hr))
    {
        hr = WdfFile->RetrieveFileName(fileName, &fileNameCch);
    }

要件

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

こちらもご覧ください

IWDFFile