Méthode IWDFDriver ::RetrieveVersionString (wudfddi.h)

Article
08/08/2023

[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 RetrieveVersionString récupère la version de l’infrastructure.

Syntaxe

HRESULT RetrieveVersionString(
  [out]     PWSTR pVersion,
  [in, out] DWORD *pdwVersionLength
);

Paramètres

[out] pVersion

Pointeur vers une mémoire tampon qui reçoit une chaîne terminée par NULL qui représente la version de l’infrastructure si la mémoire tampon fournie n’est pas NULL et que RetrieveVersionString réussit.

[in, out] pdwVersionLength

Pointeur vers une variable qui reçoit la taille, en caractères, de la chaîne de version vers laquelle pVersion pointe. Lors de l’entrée, cette variable contient la taille, en octets, de la mémoire tampon sur pVersion.

Si la mémoire tampon sur pVersion est NULL, la valeur que le pilote fournit est zéro. L’infrastructure retourne ensuite la taille, en caractères, requise pour la chaîne de version.

Si la mémoire tampon de pVersion n’est pas NULL, l’infrastructure retourne la taille, en caractères, de la chaîne de version.

Valeur retournée

RetrieveVersionString retourne S_OK pour les scénarios suivants :

La mémoire tampon vers laquelle pointe le paramètre pVersion était non NULL et suffisamment grande pour contenir la chaîne de version, y compris le caractère NULL . En outre, l’infrastructure a correctement copié la chaîne dans la mémoire tampon fournie et a défini la variable vers laquelle pointe le paramètre pdwVersionLength sur le nombre de caractères dans la chaîne.
La mémoire tampon sur pVersion était NULL, le pilote préréglait la variable à pdwVersionLength sur 0, et le framework a défini la variable sur pdwVersionLength sur le nombre de caractères requis pour la chaîne.

RetrieveVersionString 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 version. L’infrastructure définit la variable à pdwVersionLength sur le nombre de caractères requis pour la chaîne.

RetrieveVersionString 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

Partager via