Méthode IWDFDevice ::RetrieveDeviceInstanceId (wudfddi.h)

[Avertissement : UMDF 2 est la dernière version d’UMDF et remplace UMDF 1. Tous les nouveaux pilotes UMDF doivent être écrits à l’aide d’UMDF 2. Aucune nouvelle fonctionnalité n’est ajoutée à UMDF 1 et la prise en charge d’UMDF 1 est limitée sur les versions plus récentes de Windows 10. Les pilotes Windows universels doivent utiliser UMDF 2. Pour plus d’informations, consultez Prise en main avec UMDF.]

La méthode RetrieveDeviceInstanceId récupère l’identificateur d’un instance d’un appareil.

Syntaxe

HRESULT RetrieveDeviceInstanceId(
  [out, optional] PWSTR Buffer,
  [in, out]       DWORD *pdwSizeInChars
);

Paramètres

[out, optional] Buffer

Pointeur vers une mémoire tampon qui reçoit une chaîne terminée par NULL qui représente l’identificateur d’un instance de l’appareil, si la mémoire tampon fournie n’est pas NULL et que RetrieveDeviceInstanceId réussit.

[in, out] pdwSizeInChars

Pointeur vers une variable qui reçoit le nombre de caractères, y compris le caractère NULL , dans la chaîne vers laquelle buffer pointe.

Si Buffer a la valeur NULL, la valeur fournie par le pilote est zéro. L’infrastructure retourne ensuite la taille, en caractères, requise pour la chaîne d’identificateur.

Si Buffer n’a pas la valeur NULL, l’infrastructure retourne la taille, en caractères, de la chaîne d’identificateur.

Valeur retournée

RetrieveDeviceInstanceId retourne S_OK pour les scénarios suivants :

• La mémoire tampon vers laquelle le paramètre Buffer pointait était non NULL et suffisamment grande pour contenir la chaîne d’identificateur, y compris le caractère NULL , et l’infrastructure a correctement copié la chaîne dans la mémoire tampon fournie et a défini la variable pointée par le paramètre pdwSizeInChars sur le nombre de caractères dans la chaîne.
• La mémoire tampon sur Buffer était NULL, le pilote a prédéfini la variable au niveau pdwSizeInChars sur 0, et l’infrastructure a défini la variable sur pdwSizeInChars sur le nombre de caractères requis pour la chaîne.

RetrieveDeviceInstanceId retourne HRESULT_FROM_WIN32(ERROR_INSUFFICIENT_BUFFER) pour indiquer que la mémoire tampon fournie n’était pas NULL et ne contenait pas suffisamment d’espace pour contenir la chaîne d’identificateur. L’infrastructure définit la variable dans pdwSizeInChars sur le nombre de caractères requis pour la chaîne.

RetrieveDeviceInstanceId peut également retourner d’autres valeurs HRESULT.

Configuration requise

Condition requise	Valeur
Fin de la prise en charge	Non disponible dans UMDF 2.0 et versions ultérieures.
Plateforme cible	Desktop (Expérience utilisateur)
Version UMDF minimale	1.5
En-tête	wudfddi.h (inclure Wudfddi.h)
DLL	WUDFx.dll

Voir aussi

IWDFDevice