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

Recupera a descrição de um dispositivo.

Sintaxe

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

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 Plug and Play nomes de dispositivos conectados no momento chamando GetDevices.

[in, out] pDeviceDescription

Um buffer alocado pelo chamador para manter o nome de descrição do usuário do dispositivo. O chamador deve alocar a memória para esse parâmetro. Para saber o tamanho necessário para esse parâmetro, primeiro chame esse método com esse parâmetro definido como NULL e pcchDeviceDescription definido como 0; o método terá êxito e definirá pcchDeviceDescription para o tamanho do buffer necessário para manter o nome amigável do dispositivo, incluindo o caractere de encerramento.

[in, out] pcchDeviceDescription

O número de caracteres (sem incluir o caractere de terminação) em pDeviceDescription. Na entrada, o comprimento máximo de pDeviceDescription; na saída, o comprimento da cadeia de caracteres retornada em pDeviceDescription.

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 .

Requisitos

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

Confira também

GetDevices

IPortableDeviceManager Interface