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

Recupera o nome amigável do dispositivo.

Sintaxe

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

Parâmetros

[in] pszPnPDeviceID

Ponteiro para uma cadeia de caracteres terminada em nulo que contém a ID de Plug and Play do dispositivo. Você pode recuperar uma lista de nomes de Plug and Play de todos os dispositivos conectados ao computador chamando GetDevices.

[in, out] pDeviceFriendlyName

Um buffer alocado pelo chamador que é usado para conter o nome amigável do dispositivo. Para saber o tamanho necessário para esse parâmetro, primeiro chame esse método com esse parâmetro definido como NULL e pcchDeviceFriendlyName definido como 0; o método terá êxito e definirá pcchDeviceFriendlyName como o tamanho do buffer necessário para manter o nome amigável do dispositivo, incluindo o caractere de terminação.

[in, out] pcchDeviceFriendlyName

Na entrada, o número máximo de caracteres que pDeviceFriendlyName pode conter, incluindo o caractere de encerramento. Na saída, o número de caracteres retornados por pDeviceFriendlyName, incluindo também o caractere de terminação.

Retornar valor

O método retorna um HRESULT. Os possíveis valores incluem, mas sem limitação, aqueles na tabela a seguir.

Código de retorno	Descrição
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)	O buffer fornecido não é grande o suficiente para manter a descrição do dispositivo. (Consulte o valor retornado em pcchDeviceDescription para o tamanho necessário.)
HRESULT_FROM_WIN32(ERROR_INVALID_DATA)	Não foi possível encontrar a descrição do dispositivo.
S_OK	O método foi bem-sucedido.
E_POINTER	Pelo menos um dos argumentos necessários era um ponteiro NULL .

Comentários

Um dispositivo não é necessário para dar suporte a esse método. Se esse método não recuperar um nome, tente solicitar a propriedade WPD_OBJECT_NAME do objeto do dispositivo (o objeto com a ID WPD_DEVICE_OBJECT_ID).

Requisitos

Requisito	Valor
Plataforma de Destino	Windows
Cabeçalho	portabledeviceapi.h
Biblioteca	PortableDeviceGUIDs.lib

Confira também

IPortableDeviceManager Interface

IPortableDeviceManager::GetDevices