Método IPortableDeviceManager::GetDeviceDescription (portabledeviceapi.h)

Artículo
03/01/2024

Recupera la descripción de un dispositivo.

Sintaxis

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

Parámetros

[in] pszPnPDeviceID

Puntero a una cadena terminada en null que contiene el identificador de Plug and Play del dispositivo. Puede recuperar una lista de Plug and Play nombres de dispositivos que están conectados actualmente mediante una llamada a GetDevices.

[in, out] pDeviceDescription

Un búfer asignado por el autor de la llamada para contener el nombre de descripción del usuario del dispositivo. El autor de la llamada debe asignar la memoria para este parámetro. Para obtener información sobre el tamaño necesario para este parámetro, primero llame a este método con este parámetro establecido en NULL y pcchDeviceDescription establecido en 0; El método se realizará correctamente y establecerá pcchDeviceDescription en el tamaño de búfer necesario para contener el nombre descriptivo del dispositivo, incluido el carácter de terminación.

[in, out] pcchDeviceDescription

Número de caracteres (sin incluir el carácter de finalización) en pDeviceDescription. En la entrada, la longitud máxima de pDeviceDescription; en la salida, la longitud de la cadena devuelta en pDeviceDescription.

Valor devuelto

El método devuelve un valor HRESULT. Entre los valores posibles se incluyen los que se indican en la tabla siguiente, entre otros.

Código devuelto	Descripción
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)	El búfer proporcionado no es lo suficientemente grande como para contener la descripción del dispositivo. (Consulte el valor devuelto en pcchDeviceDescription para el tamaño necesario).
HRESULT_FROM_WIN32(ERROR_INVALID_DATA)	No se encontró la descripción del dispositivo.
S_OK	El método se ha llevado a cabo de forma correcta.
E_POINTER	Al menos uno de los argumentos necesarios era un puntero NULL .

Requisitos

Requisito	Value
Plataforma de destino	Windows
Encabezado	portabledeviceapi.h
Library	PortableDeviceGUIDs.lib

Consulte también

getDevices

IPortableDeviceManager (Interfaz)