IWDFDevice::RetrieveDeviceName メソッド (wudfddi.h)

  • [アーティクル]

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

RetrieveDeviceName メソッドは、基になるカーネル モード デバイスの名前を取得します。

構文

HRESULT RetrieveDeviceName(
  [out]     PWSTR pDeviceName,
  [in, out] DWORD *pdwDeviceNameLength
);

パラメーター

[out] pDeviceName

バッファーが NULL 以外で RetrieveDeviceName が成功した場合に、基になるカーネル モード デバイスの名前を表す NULL で終わる文字列を受け取るバッファーへのポインター。

[in, out] pdwDeviceNameLength

デバイス名に NULL 文字を含む文字数を受け取る変数へのポインター。

pDeviceName のバッファーが NULL の場合、ドライバーが提供する値は 0 です。 その後、フレームワークは、デバイス名の文字列に必要なサイズを文字数で返します。

pDeviceName のバッファーが NULL 以外の場合、フレームワークはデバイス名文字列のサイズを文字数で返します。

戻り値

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

  • pDeviceName パラメーターが指すバッファーは NULL 以外で、NULL 文字を含む名前文字列を保持するのに十分な大きさであり、フレームワークは指定されたバッファーに文字列を正常にコピーし、pdwDeviceNameLength が指す変数を文字列内の文字数に設定しました。
  • pDeviceName のバッファーは NULL で、ドライバーは pdwDeviceNameLength の変数を 0 に事前設定し、フレームワークは pdwDeviceNameLength の変数を文字列に必要な文字数に設定しました。

RetrieveDeviceName は、HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) を返して、指定されたバッファーが NULL ではなく、デバイス名を保持するのに十分な領域が含まれていないことを示します。 フレームワークは、 pdwDeviceNameLength の変数を、文字列に必要な文字数に設定します。

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

注釈

デバイス名が物理デバイス オブジェクト (PDO) 名ではありません。 代わりに、デバイス名はリフレクターの名前です。 ドライバーは、このデバイス オブジェクトにすべての I/O をターゲットにする必要があります。

例

次のコード例は、基になるカーネル モード デバイスの名前を取得する方法を示しています。

    PWSTR deviceName = NULL;
    DWORD deviceNameCch = 0;
    HRESULT hr;
    //
    // Get the length of the device name to allocate a buffer
    //
    hr = m_FxDevice->RetrieveDeviceName(NULL, &deviceNameCch);
    //
    // Allocate the buffer
    //
    deviceName = new WCHAR[deviceNameCch];

    if (deviceName == NULL) {
        hr = E_OUTOFMEMORY;
        goto Exit1;
    }
    //
    // Get the device name
    //
    hr = m_FxDevice->RetrieveDeviceName(deviceName,
                                        &deviceNameCch);

    // Open the device and get the handle

    m_Handle = CreateFile(deviceName, 
                         (GENERIC_READ | GENERIC_WRITE), 
                         0, 
                         NULL, 
                         OPEN_EXISTING, 
                         FILE_FLAG_OVERLAPPED, 
                         NULL);

要件

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

こちらもご覧ください

IWDFDevice