Поделиться через

Метод IPortableDeviceManager::GetDeviceFriendlyName (portabledeviceapi.h)

  • Статья

Извлекает понятное имя устройства.

Синтаксис

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

Параметры

[in] pszPnPDeviceID

Указатель на строку, завершающуюся значением NULL, которая содержит идентификатор Plug and Play устройства. Список Plug and Play имен всех устройств, подключенных к компьютеру, можно получить, вызвав Метод GetDevices.

[in, out] pDeviceFriendlyName

Буфер, выделенный вызывающим объектом, который используется для хранения понятного имени устройства. Чтобы узнать требуемый размер для этого параметра, сначала вызовите этот метод с параметром NULL и параметром pcchDeviceFriendlyName , равным 0; Метод будет выполнен успешно и присвоит pcchDeviceFriendlyName необходимый размер буфера для хранения понятного для устройства имени, включая символ завершения.

[in, out] pcchDeviceFriendlyName

При входе максимальное количество символов, которое может содержать pDeviceFriendlyName , включая символ завершения. В выходных данных — количество символов, возвращаемых pDeviceFriendlyName, включая символ завершения.

Возвращаемое значение

Метод возвращает HRESULT. Допустимые значения включают, но не ограничиваются, значения, приведенные в следующей таблице.

Код возврата Описание
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)
 Предоставленный буфер недостаточно велик для хранения описания устройства. (Требуемый размер см. в описании значения, возвращаемого в pcchDeviceDescription .)
HRESULT_FROM_WIN32(ERROR_INVALID_DATA)
 Не удалось найти описание устройства.
S_OK
 Метод выполнен успешно.
E_POINTER
 По крайней мере один из обязательных аргументов был пустым указателем.

Комментарии

Устройство не требуется для поддержки этого метода. Если этому методу не удается получить имя, попробуйте запросить свойство WPD_OBJECT_NAME объекта устройства (объект с идентификатором WPD_DEVICE_OBJECT_ID).

Требования

Требование Значение
Целевая платформа Windows
Header portabledeviceapi.h
Библиотека PortableDeviceGUIDs.lib

См. также раздел

Интерфейс IPortableDeviceManager

IPortableDeviceManager::GetDevices