Partager via


IWDFDeviceInitialize ::RetrieveDeviceInstanceId, méthode (wudfddi.h)

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

La méthode RetrieveDeviceInstanceId récupère l’identificateur d’une 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 null NULL-terminated qui représente l’identificateur d’une instance d’un appareil si la mémoire tampon fournie n’est pas -NULL et 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 tampon pointe.

Si tampon est NULL, la valeur que le pilote fournit est égale à zéro. L’infrastructure retourne ensuite la taille, en caractères, requise pour la chaîne d’identificateur.

Si de mémoire tampon n’est pasNULL, l’infrastructure retourne la taille, en caractères, de la chaîne d’identificateur.

Valeur de retour

RetrieveDeviceInstanceId retourne S_OK pour les scénarios suivants :

  • La mémoire tampon vers laquelle le paramètre mémoire tampon pointait n’était pasNULL et suffisamment volumineux 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 défini la variable pointée par le paramètre pdwSizeInChars au nombre de caractères de la chaîne.
  • La mémoire tampon à de la mémoire tampon a été NULL, le pilote prédéfini la variable à 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’est pas NULL et ne contient pas suffisamment d’espace pour contenir la chaîne d’identificateur. L’infrastructure définit la variable à pdwSizeInChars le nombre de caractères requis pour la chaîne.

RetrieveDeviceInstanceId peut également retourner d’autres valeurs HRESULT.

Exigences

Exigence Valeur
fin du support Indisponible dans UMDF 2.0 et versions ultérieures.
plateforme cible Bureau
version minimale de UMDF 1.5
d’en-tête wudfddi.h (include Wudfddi.h)
DLL WUDFx.dll

Voir aussi

IWDFDeviceInitialize