WdfDeviceRetrieveDeviceInterfaceString 函式 (wdfdevice.h)

  • 發行項

[適用於 KMDF 和 UMDF]

WdfDeviceRetrieveDeviceInterfaceString 方法會擷取操作系統指派給驅動程式為指定裝置註冊之裝置介面的符號連結名稱。

語法

NTSTATUS WdfDeviceRetrieveDeviceInterfaceString(
  [in]           WDFDEVICE        Device,
  [in]           const GUID       *InterfaceClassGUID,
  [in, optional] PCUNICODE_STRING ReferenceString,
  [in]           WDFSTRING        String
);

參數

[in] Device

架構裝置物件的句柄。

[in] InterfaceClassGUID

識別裝置介面類別之 GUID 的指標。

[in, optional] ReferenceString

描述裝置介面參考字串 之UNICODE_STRING 結構的指標。 如果驅動程式在呼叫 WdfDeviceCreateDeviceInterface 時未指定參考字串，這個參數是選擇性的，而且可以是 NULL。

[in] String

架構字串物件的句柄。 架構會將符號連結名稱的 Unicode 字串指派給字串物件。

傳回值

如果作業成功，WdfDeviceRetrieveDeviceInterfaceString 會傳回STATUS_SUCCESS。 否則，方法可能會傳回下列其中一個值：

傳回碼 Description
STATUS_INVALID_DEVICE_REQUEST

未在 IRQL = PASSIVE_LEVEL呼叫 WdfDeviceRetrieveDeviceInterfaceString。
STATUS_INVALID_PARAMETER
 指定了無效的參數。
STATUS_INVALID_DEVICE_REQUEST
 指定的裝置物件是由 WdfControlDeviceInitAllocate 初始化。
STATUS_OBJECT_NAME_NOT_FOUND
 找不到符合指定 GUID 和參考字串的裝置介面。
STATUS_INVALID_DEVICE_STATE
 名為 WdfDeviceCreateDeviceInterface 的 驅動程式，但系統尚未將符號連結名稱指派給裝置介面。
 

WdfDeviceRetrieveDeviceInterfaceString 也可能傳回其他 NTSTATUS 值。

如果驅動程式提供無效的物件句柄，就會發生錯誤檢查。

備註

如需裝置介面的詳細資訊，請參閱 使用裝置介面。

範例

下列程式代碼範例會建立字串對象，然後擷取指定的裝置介面符號連結名稱。

NTSTATUS status;
WDFSTRING string;

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

規格需求

需求 值
目標平台 Universal
最小 KMDF 版本 1.0
最低UMDF版本 2.0
標頭 wdfdevice.h (包含 Wdf.h)
程式庫 Wdf01000.sys (KMDF) ;WUDFx02000.dll (UMDF)
IRQL PASSIVE_LEVEL
DDI 合規性規則 DriverCreate (kmdf) 、 KmdfIrql (kmdf) 、 KmdfIrql2 (kmdf) 、 KmdfIrqlExplicit (kmdf)

另請參閱

UNICODE_STRING

WdfControlDeviceInitAllocate

WdfDeviceCreateDeviceInterface

WdfStringCreate