IWDFDeviceInitialize::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终止字符串的缓冲区的指针,该字符串表示设备实例的标识符(如果提供的缓冲区不是非NULL,并且 RetrieveDeviceInstanceId 成功。
[in, out] pdwSizeInChars
指向接收字符数(包括 NULL 字符)的变量的指针,该字符串 Buffer 指向。
如果 缓冲区NULL,则驱动程序提供的值为零。 然后,框架返回标识符字符串所需的大小(以字符为单位)。
如果 缓冲区 为非NULL,则框架将返回标识符字符串的大小(以字符为单位)。
返回值
RetrieveDeviceInstanceId 返回以下方案的S_OK:
- Buffer 参数指向的缓冲区是非NULL,并且足够大,用于保存标识符字符串(包括 NULL 字符)的缓冲区,框架成功将字符串复制到提供的缓冲区中,并将 pdwSizeInChars 参数指向的变量设置为字符串中的字符数。
- Buffer 的缓冲区 NULL,驱动程序将变量预设为 pdwSizeInChars 0,框架将变量设置为字符串所需的字符数 pdwSizeInChars。
RetrieveDeviceInstanceId 也可能返回其他 HRESULT 值。
要求
要求 | 价值 |
---|---|
终止支持 | 在 UMDF 2.0 及更高版本中不可用。 |
目标平台 | 桌面 |
最低 UMDF 版本 | 1.5 |
标头 | wudfddi.h (包括 Wudfddi.h) |
DLL | WUDFx.dll |