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

Article
03/01/2024

Récupère le nom convivial de l’appareil.

Syntaxe

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

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 une liste de noms de Plug-and-Play de tous les appareils connectés à l’ordinateur en appelant GetDevices.

[in, out] pDeviceFriendlyName

Mémoire tampon allouée à l’appelant qui est utilisée pour contenir le nom convivial de l’appareil. 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 pcchDeviceFriendlyName défini sur 0 ; la méthode réussit et définit pcchDeviceFriendlyName 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] pcchDeviceFriendlyName

Lors de l’entrée, le nombre maximal de caractères que pDeviceFriendlyName peut contenir, y compris le caractère d’arrêt. Lors de la sortie, le nombre de caractères retournés par pDeviceFriendlyName, y compris le caractère d’arrêt.

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 l’un des arguments requis était un pointeur NULL .

Remarques

Un appareil n’est pas nécessaire pour prendre en charge cette méthode. Si cette méthode ne parvient pas à récupérer un nom, essayez de demander la propriété WPD_OBJECT_NAME de l’objet d’appareil (l’objet avec l’ID WPD_DEVICE_OBJECT_ID).

Configuration requise

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

Voir aussi

IPortableDeviceManager, interface

IPortableDeviceManager ::GetDevices

Partager via