共用方式為


IWDFDevice::RetrieveDeviceInstanceId 方法 (wudfddi.h)

[警告: UMDF 2 是最新版本的 UMDF,並取代 UMDF 1。 所有新的UMDF驅動程式都應該使用UMDF 2撰寫。 未將新功能新增至 UMDF 1,而且較新版本的 Windows 10 上對 UMDF 1 的支援有限。 通用 Windows 驅動程式必須使用 UMDF 2。 如需詳細資訊,請參閱 開始使用 UMDF。]

RetrieveDeviceInstanceId 方法會擷取裝置實例的識別碼。

語法

HRESULT RetrieveDeviceInstanceId(
  [out, optional] PWSTR Buffer,
  [in, out]       DWORD *pdwSizeInChars
);

參數

[out, optional] Buffer

如果提供的緩衝區不是非NULL,且 RetrieveDeviceInstanceId 成功,則為緩衝區的指標,該字符串會接收 NULL-terminatedeviceInstanceId 的標識符。

[in, out] pdwSizeInChars

緩衝區 指向的字串中,接收字元數目的變數指標,包括 NULL 字元。

如果 BufferNULL,則驅動程式提供的值為零。 架構接著會傳回標識符字串所需的大小,以字元為單位。

如果 Buffer 為非NULL,則架構會傳回標識符字串的大小,以字元為單位。

傳回值

RetrieveDeviceInstanceId 會針對下列案例傳回S_OK:

  • Buffer 參數指向的緩衝區是非NULL,而且足以容納標識符字串,包括 NULL 字元,而且架構已成功將字元串複製到提供的緩衝區,並將 pdwSizeInChars 參數所指向的變數設定為字元串中的字元數。
  • Buffer 的緩衝區 NULL,驅動程式會將變數預設為 pdwSizeInChars 為 0,而架構會將變數設定為 pdwSizeInChars 字串所需的字元數。
RetrieveDeviceInstanceId 會傳回 HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER),表示提供的緩衝區不是非NULL,而且未包含足夠的空間來保存標識符字串。 架構會將 pdwSizeInChars 上的變數設定為字串所需的字元數。

RetrieveDeviceInstanceId 也可能傳回其他 HRESULT 值。

要求

要求 價值
終止支援 UMDF 2.0 和更新版本中無法使用。
目標平臺 桌面
最低 UMDF 版本 1.5
標頭 wudfddi.h (包括 Wudfddi.h)
DLL WUDFx.dll

另請參閱

IWDFDevice