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

Récupère la description d’un appareil.

Syntaxe

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

Paramètres

[in] pszPnPDeviceID

Pointeur vers une chaîne terminée par null qui contient l’ID de Plug-and-Play de l’appareil. Vous pouvez récupérer la liste des noms de Plug-and-Play des appareils actuellement connectés en appelant GetDevices.

[in, out] pDeviceDescription

Mémoire tampon allouée à l’appelant pour contenir le nom de description de l’utilisateur de l’appareil. L’appelant doit allouer la mémoire pour ce paramètre. Pour connaître la taille requise pour ce paramètre, appelez d’abord cette méthode avec ce paramètre défini sur NULL et pcchDeviceDescription sur 0 ; la méthode réussit et définit pcchDeviceDescription sur la taille de mémoire tampon requise pour contenir le nom convivial de l’appareil, y compris le caractère d’arrêt.

[in, out] pcchDeviceDescription

Nombre de caractères (sans le caractère de fin) dans pDeviceDescription. En entrée, la longueur maximale de pDeviceDescription ; en sortie, longueur de la chaîne retournée dans pDeviceDescription.

Valeur retournée

Cette méthode retourne un code HRESULT. Les valeurs possibles sont notamment celles figurant dans le tableau suivant.

Code de retour	Description
HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER)	La mémoire tampon fournie n’est pas assez grande pour contenir la description de l’appareil. (Reportez-vous à la valeur retournée dans pcchDeviceDescription pour connaître la taille requise.)
HRESULT_FROM_WIN32(ERROR_INVALID_DATA)	La description de l’appareil est introuvable.
S_OK	S_OK
E_POINTER	Au moins un des arguments requis était un pointeur NULL .

Configuration requise

Condition requise	Valeur
Plateforme cible	Windows
En-tête	portabledeviceapi.h
Bibliothèque	PortableDeviceGUIDs.lib

Voir aussi

GetDevices

IPortableDeviceManager, interface