fonction HidP_GetSpecificValueCaps (hidpi.h)
La routine HidP_GetSpecificValueCaps retourne un tableau de capacités de valeur qui décrit toutes les valeurs de contrôle HID qui répondent à un critère de sélection spécifié.
Syntaxe
NTSTATUS HidP_GetSpecificValueCaps(
[in] HIDP_REPORT_TYPE ReportType,
[in] USAGE UsagePage,
[in] USHORT LinkCollection,
[in] USAGE Usage,
[out] PHIDP_VALUE_CAPS ValueCaps,
[in, out] PUSHORT ValueCapsLength,
[in] PHIDP_PREPARSED_DATA PreparsedData
);
Paramètres
[in] ReportType
Spécifie une valeur d’énumérateur HIDP_REPORT_TYPE qui identifie le type de rapport.
[in] UsagePage
Spécifie une page d’utilisation en tant que critères de recherche. Si UsagePage n’est pas zéro, seules les valeurs qui spécifient cette page d’utilisation sont retournées.
[in] LinkCollection
Spécifie une collection de liens en tant que critères de recherche. Si LinkCollection n’est pas zéro, seules les valeurs qui font partie de cette collection de liens sont retournées.
[in] Usage
Spécifie un d’utilisation HID en tant que critères de recherche. Si 'utilisation n’est pas zéro, seules les valeurs qui spécifient cette utilisation sont retournées.
[out] ValueCaps
Pointeur vers une mémoire tampon allouée par l’appelant dans laquelle la routine retourne un tableau de capacités de valeur pour le type de rapport spécifié.
[in, out] ValueCapsLength
Spécifie la longueur de l’entrée, dans les éléments de tableau, de la mémoire tampon fournie à ValueCaps. En sortie, ce paramètre est défini sur le nombre d’éléments retournés par la routine.
[in] PreparsedData
Pointeur vers un collection de niveau supérieurdonnées préparées.
Valeur de retour
HidP_GetSpecificValueCaps retourne l’une des valeurs d’état suivantes :
Retourner le code | Valeur d’état NT | Description |
---|---|---|
|
|
La routine a correctement retourné les données de capacité. |
|
|
Les données prédéfinies ne sont pas valides. |
|
|
L’utilisation n’existe pas dans un rapport du type de rapport spécifié. |
Remarques
La taille requise de la mémoire tampon ValueCaps est spécifiée par le NombreXxxValueCaps membres d’une structure HIDP_CAPS de collection de niveau supérieur.
Lorsque vous appelez HidP_GetSpecificValueCaps, en spécifiant zéro pour UsagePage, Utilisationet LinkCollection équivaut à appeler HidP_GetValueCaps.
Pour plus d’informations sur la fonctionnalité d’une collection, consultez Obtention des informations de collecte.
Voir également collections HID.
Exigences
Exigence | Valeur |
---|---|
client minimum pris en charge | Disponible dans Windows 2000 et versions ultérieures de Windows. |
plateforme cible | Universel |
d’en-tête | hidpi.h (include Hidpi.h) |
bibliothèque | Hidparse.lib |
IRQL | PASSIVE_LEVEL |