fonction HidD_GetSerialNumberString (hidsdi.h)

Article
02/27/2024

La routine HidD_GetSerialNumberString retourne la chaîne incorporée d’une collection de niveau supérieur qui identifie le numéro de série de l’appareil physique de la collection.

Syntaxe

BOOLEAN HidD_GetSerialNumberString(
  [in]  HANDLE HidDeviceObject,
  [out] PVOID  Buffer,
  [in]  ULONG  BufferLength
);

Paramètres

[in] HidDeviceObject

Spécifie un handle ouvert à une collection de niveau supérieur.

[out] Buffer

Pointeur vers une mémoire tampon allouée à l’appelant que la routine utilise pour retourner la chaîne de numéro de série demandée. La routine retourne une chaîne de caractères larges terminée par NULL.

[in] BufferLength

Spécifie la longueur, en octets, d’une mémoire tampon allouée à l’appelant fournie dans Buffer. Si la mémoire tampon n’est pas assez grande pour renvoyer la chaîne incorporée terminée par NULL entière, la routine ne retourne rien dans la mémoire tampon. La mémoire tampon fournie doit être <= 4 093 octets (2^12 – 3).

Valeur retournée

HidD_GetSerialNumberString retourne TRUE s’il retourne correctement la chaîne incorporée terminée par NULL entière. Sinon, la routine retourne FALSE. Utilisez GetLastError pour obtenir des informations d’erreur étendues.

Remarques

Seules les applications en mode utilisateur peuvent appeler HidD_GetSerialNumberString. Les pilotes en mode noyau peuvent utiliser IOCTL_HID_GET_SERIALNUMBER_STRING.

Le nombre maximal possible de caractères dans une chaîne incorporée est spécifique à l’appareil. Pour les périphériques USB, la longueur de chaîne maximale est de 126 caractères de large (sans compter le caractère NULL de fin).

Si la mémoire tampon fournie n’est pas <= 4 093 octets (2^12 – 3), l’appel peut échouer (en fonction du protocole sous-jacent, HID/Bluetooth/SPI) avec le code d’erreur ERROR_GEN_FAILURE (0x0000001f)

Pour plus d’informations, consultez Collections HID.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Disponible dans Windows 2000 et versions ultérieures de Windows.
Plateforme cible	Universal
En-tête	hidsdi.h (inclure Hidsdi.h)
Bibliothèque	Hid.lib
DLL	Hid.dll