fonction HidP_GetSpecificValueCaps (hidpi.h)

Article
08/07/2023

La routine HidP_GetSpecificValueCaps retourne un tableau de fonctionnalités de valeurs 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 comme critère de recherche. Si UsagePage est différent de zéro, seules les valeurs qui spécifient cette page d’utilisation sont retournées.

[in] LinkCollection

Spécifie une collection de liens comme critère de recherche. Si LinkCollection n’est pas nul, seules les valeurs qui font partie de cette collection de liens sont retournées.

[in] Usage

Spécifie une utilisation hid comme critère de recherche. Si l’utilisation n’est pas nulle, seules les valeurs qui spécifient cette utilisation sont retournées.

[out] ValueCaps

Pointeur vers une mémoire tampon allouée à l’appelant dans laquelle la routine retourne un tableau de capacité 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 dans ValueCaps. Sur la sortie, ce paramètre est défini sur le nombre d’éléments que la routine retourne réellement.

[in] PreparsedData

Pointeur vers les données préparées d’une collection de niveau supérieur.

Valeur retournée

HidP_GetSpecificValueCaps retourne l’une des valeurs status suivantes :

Code de retour	Valeur d’état NT	Description
HIDP_STATUS_SUCCESS	0x00110000	La routine a correctement retourné les données de fonctionnalité.
HIDP_STATUS_INVALID_PREPARSED_DATA	0xc0110001	Les données préparées ne sont pas valides.
HIDP_STATUS_USAGE_NOT_FOUND	0xc0110004	L’utilisation n’existe dans aucun rapport du type de rapport spécifié.

Remarques

La taille requise de la mémoire tampon ValueCaps est spécifiée par les membres NumberXxxValueCaps de la structure HIDP_CAPS d’une collection de niveau supérieur.

Lorsque vous appelez HidP_GetSpecificValueCaps, spécifier zéro pour UsagePage, Usage et LinkCollection équivaut à appeler HidP_GetValueCaps.

Pour plus d’informations sur la fonctionnalité d’une collection, consultez Obtention d’informations de collection.

Voir aussi Les 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	hidpi.h (inclure Hidpi.h)
Bibliothèque	Hidparse.lib
IRQL	PASSIVE_LEVEL

Voir aussi

Partager via