WdfDeviceRetrieveDeviceName 函式 (wdfdevice.h)

  • 發行項

[僅適用於 KMDF]

WdfDeviceRetrieveDeviceName 方法會傳回指定裝置的裝置名稱。

語法

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

參數

[in] Device

架構裝置物件的句柄。

[in] String

接收裝置名稱的架構字串物件的句柄。

傳回值

如果作業成功， WdfDeviceRetrieveDeviceName 會傳回STATUS_SUCCESS。 其他傳回值包括：

傳回碼 Description
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;
    }
}

規格需求

需求 值
目標平台 Universal
最小 KMDF 版本 1.0
標頭 wdfdevice.h (包含 Wdf.h)
程式庫 Wdf01000.sys (請參閱 Framework Library Versioning.)
IRQL PASSIVE_LEVEL
DDI 合規性規則 DriverCreate (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf)

另請參閱

WdfDeviceInitAssignName

WdfDeviceQueryProperty

WdfStringCreate