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

Статья
08/25/2023

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

Синтаксис

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

Параметры

[in] pszPnPDeviceID

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

[in, out] pDeviceDescription

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

[in, out] pcchDeviceDescription

Количество символов (не включая символ завершения) в pDeviceDescription. На входных данных — максимальная длина pDeviceDescription; в выходных данных — длина возвращаемой строки в pDeviceDescription.

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

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

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

Требования

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

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

GetDevices

Интерфейс IPortableDeviceManager

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