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

  • Artículo

Recupera el nombre descriptivo del dispositivo.

Sintaxis

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

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 todos los dispositivos conectados al equipo mediante una llamada a GetDevices.

[in, out] pDeviceFriendlyName

Búfer asignado por el autor de la llamada que se usa para contener el nombre descriptivo del dispositivo. 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 pcchDeviceFriendlyName establecido en 0; El método se realizará correctamente y establecerá pcchDeviceFriendlyName en el tamaño de búfer necesario para contener el nombre descriptivo del dispositivo, incluido el carácter de terminación.

[in, out] pcchDeviceFriendlyName

En la entrada, el número máximo de caracteres que pDeviceFriendlyName puede contener, incluido el carácter de terminación. En la salida, el número de caracteres devueltos por pDeviceFriendlyName, también incluye el carácter de terminación.

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 .

Comentarios

No se requiere un dispositivo para admitir este método. Si este método no puede recuperar un nombre, intente solicitar la propiedad WPD_OBJECT_NAME del objeto de dispositivo (el objeto con el identificador WPD_DEVICE_OBJECT_ID).

Requisitos

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

Consulte también

IPortableDeviceManager (Interfaz)

IPortableDeviceManager::GetDevices