Share via

HidP_GetLinkCollectionNodes (Compact 2013)

  • Article

3/26/2014

This function returns a top-level collection's link collection array.

Syntax

NTSTATUS HidP_GetLinkCollectionNodes(
  PHIDP_LINK_COLLECTION_NODE LinkCollectionNodes,
  PULONG LinkCollectionNodesLength,
  PHIDP_PREPARSED_DATA PreparsedData
);

Parameters

  • LinkCollectionNodes
    [out] 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.
  • LinkCollectionNodesLength
    [in, out] On input, the length, in array elements, of the LinkCollectionNodes buffer. On output, the function sets LinkCollectionNodesLength to the number of entries in the array that it set.
  • PreparsedData
    [in] Pointer to the preparsed data of the top-level collection for which this function returns a link collection array.

Return Value

Returns HIDP_STATUS_SUCCESS if the function successfully returned the specified collection's link collection array. Returns HIDP_STATUS_BUFFER_TOO_SMALL if the LinkCollectionNodes buffer is too small to hold the entire link collection array.

Remarks

The NumberLinkCollectionNodes member of a collection's HIDP_CAPS structure specifies the required length of the LinkCollectionNodes buffer.

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.

Requirements

Header

hidpi.h

Library

Hidparse_lib.lib

See Also

Reference

HID Parser Functions
HidP_GetCaps
HIDP_CAPS
HIDP_LINK_COLLECTION_NODE