IPortableDeviceManager::GetDeviceFriendlyName 方法 (portabledeviceapi.h)

检索设备的用户友好名称。

语法

HRESULT GetDeviceFriendlyName(
  [in]      LPCWSTR pszPnPDeviceID,
  [in, out] WCHAR   *pDeviceFriendlyName,
  [in, out] DWORD   *pcchDeviceFriendlyName
);

参数

[in] pszPnPDeviceID

指向以 null 结尾的字符串的指针,该字符串包含设备的即插即用 ID。 可以通过调用 GetDevices 检索连接到计算机的所有设备的即插即用名称的列表。

[in, out] pDeviceFriendlyName

调用方分配的缓冲区,用于保存设备的用户友好名称。 若要了解此参数所需的大小,请先调用此方法,并将此参数设置为 NULL ,并将 pcchDeviceFriendlyName 设置为 0;方法将成功,并将 pcchDeviceFriendlyName 设置为保存设备友好名称(包括终止字符)所需的缓冲区大小。

[in, out] pcchDeviceFriendlyName

输入时, pDeviceFriendlyName 可以容纳的最大字符数,包括终止字符。 输出时, pDeviceFriendlyName 返回的字符数,也包括终止字符。

返回值

该方法返回 HRESULT。 可能的值包括(但并不限于)下表中的项。

返回代码 说明
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)
提供的缓冲区不够大,无法容纳设备说明。 (请参考 pcchDeviceDescription 中返回的所需 size 的值。)
HRESULT_FROM_WIN32 (ERROR_INVALID_DATA)
找不到设备说明。
S_OK
方法成功。
E_POINTER
至少一个必需的参数是 NULL 指针。

注解

无需设备即可支持此方法。 如果此方法无法检索名称,请尝试请求 id 为WPD_DEVICE_OBJECT_ID) (设备对象的WPD_OBJECT_NAME属性。

要求

要求
目标平台 Windows
标头 portabledeviceapi.h
Library PortableDeviceGUIDs.lib

另请参阅

IPortableDeviceManager 接口

IPortableDeviceManager::GetDevices