WdfDeviceRetrieveDeviceName 関数 (wdfdevice.h)

  • [アーティクル]

[KMDF にのみ適用]

WdfDeviceRetrieveDeviceName メソッドは、指定されたデバイスのデバイス名を返します。

構文

NTSTATUS WdfDeviceRetrieveDeviceName(
  [in] WDFDEVICE Device,
  [in] WDFSTRING String
);

パラメーター

[in] Device

フレームワーク デバイス オブジェクトへのハンドル。

[in] String

デバイス名を受け取るフレームワーク文字列オブジェクトへのハンドル。

戻り値

操作が成功した場合、 WdfDeviceRetrieveDeviceName はSTATUS_SUCCESSを返します。 その他の戻り値は次のとおりです。

リターン コード 説明
STATUS_INVALID_PARAMETER
 無効なパラメーターが検出されました。
 

メソッドは、他の NTSTATUS 値を返す場合があります。

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

注釈

WdfDeviceRetrieveDeviceName メソッドは、以前の WdfDeviceInitAssignName の呼び出しでドライバーが指定したデバイス名を返します。

文字列オブジェクトからデバイス名の文字列を取得するために、ドライバーは WdfStringGetUnicodeString を呼び出すことができます。

例

次のコード例では、文字列オブジェクトを作成し、指定したデバイスの名前を取得します。

NTSTATUS status;
WDFSTRING string;

status = WdfStringCreate(
                         NULL,
                         WDF_NO_OBJECT_ATTRIBUTES,
                         &string
                         );
if (NT_SUCCESS(status)) {
    status = WdfDeviceRetrieveDeviceName(
                                         Device,
                                         string
                                         );
    if (!NT_SUCCESS(status)) {
        return status;
    }
}

要件

要件 値
対象プラットフォーム ユニバーサル
最小 KMDF バージョン 1.0
Header wdfdevice.h (Wdf.h を含む)
Library Wdf01000.sys (「Framework ライブラリのバージョン管理」を参照)。
IRQL PASSIVE_LEVEL
DDI コンプライアンス規則 DriverCreate(kmdf)、 KmdfIrql(kmdf)、 KmdfIrql2(kmdf)、KmdfIrqlExplicit(kmdf)

こちらもご覧ください

WdfDeviceInitAssignName

WdfDeviceQueryProperty

WdfStringCreate