IPortableDeviceManager::GetDeviceDescription 方法 (portabledeviceapi.h)

检索设备的说明。

语法

HRESULT GetDeviceDescription(
  [in]      LPCWSTR pszPnPDeviceID,
  [in, out] WCHAR   *pDeviceDescription,
  [in, out] DWORD   *pcchDeviceDescription
);

参数

[in] pszPnPDeviceID

指向包含设备即插即用 ID 的以 null 结尾的字符串的指针。 可以通过调用 GetDevices 检索当前连接的即插即用设备名称的列表。

[in, out] pDeviceDescription

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

[in, out] pcchDeviceDescription

pDeviceDescription 中 (不包括终止字符) 的字符数。 输入时, pDeviceDescription 的最大长度;输出中返回的字符串的长度( 以 pDeviceDescription 表示)。

返回值

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

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

要求

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

另请参阅

GetDevices

IPortableDeviceManager 接口