HidP_GetLinkCollectionNodes routine

The HidP_GetLinkCollectionNodes routine returns a top-level collection's link collection array.

Syntax


NTSTATUS __stdcall HidP_GetLinkCollectionNodes(
  _Out_    PHIDP_LINK_COLLECTION_NODE LinkCollectionNodes,
  _Inout_  PULONG LinkCollectionNodesLength,
  _In_     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]

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.

PreparsedData [in]

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 codeDescription
HIDP_STATUS_SUCCESS

The routine successfully returned the specified collection's link collection array.

HIDP_STATUS_BUFFER_TOO_SMALL

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

Version

Available in Windows 2000 and later versions of Windows.

Header

Hidpi.h (include Hidpi.h)

Library

Hidparse.lib

IRQL

<= DISPATCH_LEVEL

See also

_HIDP_PREPARSED_DATA
HidP_GetCaps
HIDP_CAPS
HIDP_LINK_COLLECTION_NODE

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft