HidP_GetLinkCollectionNodes function (hidpi.h)
The HidP_GetLinkCollectionNodes routine returns a top-level collection's link collection array.
Syntax
NTSTATUS HidP_GetLinkCollectionNodes(
[out] PHIDP_LINK_COLLECTION_NODE LinkCollectionNodes,
[in, out] PULONG LinkCollectionNodesLength,
[in] PHIDP_PREPARSED_DATA PreparsedData
);
Parameters
[out] LinkCollectionNodes
Pointer to a caller-allocated array of HIDP_LINK_COLLECTION_NODE structures in which HidP_GetLinkCollectionNodes returns a top-level collection's link collection array.
[in, out] LinkCollectionNodesLength
Specifies, on input, the length, in array elements, of the LinkCollectionNodes buffer. On output, the routine sets LinkCollectionNodesLength to the number of entries in the array that it set.
[in] PreparsedData
Pointer to the preparsed data of the top-level collection for which this routine returns a link collection array.
Return value
HidP_GetLinkCollectionNodes returns one of the following status codes:
| Return code | Description |
|---|---|
|
The routine successfully returned the specified collection's link collection array. |
|
The preparsed data is not valid. |
|
The LinkCollectionNodes buffer is too small to hold the entire link collection array. |
Remarks
The required length of the LinkCollectionNodes buffer is specified by the NumberLinkCollectionNodes member of a collection's HIDP_CAPS structure.
If HidP_GetLinkCollectionNodes returns the status value HIDP_STATUS_BUFFER_TOO_SMALL, it also sets LinkCollectionNodesLength to the length, in array elements, required to hold the link collection nodes information.
For more information, see HID Collections.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Available in Windows 2000 and later versions of Windows. |
| Target Platform | Universal |
| Header | hidpi.h (include Hidpi.h) |
| Library | Hidparse.lib |
| IRQL | <= DISPATCH_LEVEL |