HidP_GetLinkCollectionNodes, fonction (hidpi.h)

Article
08/07/2023

La routine HidP_GetLinkCollectionNodes retourne le tableau de collection de liens d’une collection de niveau supérieur.

Syntaxe

NTSTATUS HidP_GetLinkCollectionNodes(
  [out]     PHIDP_LINK_COLLECTION_NODE LinkCollectionNodes,
  [in, out] PULONG                     LinkCollectionNodesLength,
  [in]      PHIDP_PREPARSED_DATA       PreparsedData
);

Paramètres

[out] LinkCollectionNodes

Pointeur vers un tableau alloué par l’appelant de structures HIDP_LINK_COLLECTION_NODE dans laquelle HidP_GetLinkCollectionNodes retourne le tableau de collection de liens d’une collection de niveau supérieur.

[in, out] LinkCollectionNodesLength

Spécifie, lors de l’entrée, la longueur, dans les éléments de tableau, de la mémoire tampon LinkCollectionNodes . Lors de la sortie, la routine définit LinkCollectionNodesLength sur le nombre d’entrées dans le tableau qu’elle a définie.

[in] PreparsedData

Pointeur vers les données préparées de la collection de niveau supérieur pour laquelle cette routine retourne un tableau de collection de liens.

Valeur retournée

HidP_GetLinkCollectionNodes retourne l’un des codes status suivants :

Code de retour	Description
HIDP_STATUS_SUCCESS	La routine a correctement retourné le tableau de collection de liens de la collection spécifiée.
HIDP_STATUS_INVALID_PREPARSED_DATA	Les données préparées ne sont pas valides.
HIDP_STATUS_BUFFER_TOO_SMALL	La mémoire tampon LinkCollectionNodes est trop petite pour contenir l’intégralité du tableau de collection de liens.

Remarques

La longueur requise de la mémoire tampon LinkCollectionNodes est spécifiée par le membre NumberLinkCollectionNodes de la structure HIDP_CAPS d’une collection.

Si HidP_GetLinkCollectionNodes retourne la valeur status HIDP_STATUS_BUFFER_TOO_SMALL, elle définit également LinkCollectionNodesLength sur la longueur, dans les éléments de tableau, requise pour contenir les informations sur les nœuds de la collection de liens.

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	hidpi.h (inclure Hidpi.h)
Bibliothèque	Hidparse.lib
IRQL	<= DISPATCH_LEVEL

Voir aussi

HIDP_CAPS

HIDP_LINK_COLLECTION_NODE

HidP_GetCaps

_HIDP_PREPARSED_DATA

Partager via