функция HidP_GetLinkCollectionNodes (hidpi.h)

Подпрограмма HidP_GetLinkCollectionNodes возвращает массив ссылок коллекцииверхнего уровня.

Синтаксис

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

Параметры

[out] LinkCollectionNodes

Указатель на выделенный вызывающим объектом массив структур HIDP_LINK_COLLECTION_NODE, в котором HidP_GetLinkCollectionNodes возвращает массив ссылок коллекции верхнего уровня.

[in, out] LinkCollectionNodesLength

Указывает для входных данных длину буфера LinkCollectionNodes в элементах массива. В выходных данных подпрограмма устанавливает для LinkCollectionNodesLength количество записей в заданном массиве.

[in] PreparsedData

Указатель на подготовленные данные коллекции верхнего уровня, для которой эта подпрограмма возвращает массив коллекции ссылок.

Возвращаемое значение

HidP_GetLinkCollectionNodes возвращает один из следующих кодов состояния:

Код возврата Описание
HIDP_STATUS_SUCCESS
Подпрограмма успешно вернула массив коллекции ссылок указанной коллекции.
HIDP_STATUS_INVALID_PREPARSED_DATA
Подготовленные данные являются недопустимыми.
HIDP_STATUS_BUFFER_TOO_SMALL
Буфер LinkCollectionNodes слишком мал для хранения всего массива коллекции ссылок.

Комментарии

Требуемая длина буфера LinkCollectionNodes определяется элементом NumberLinkCollectionNodesHIDP_CAPS структуры коллекции.

Если HidP_GetLinkCollectionNodes возвращает значение состояния HIDP_STATUS_BUFFER_TOO_SMALL, он также устанавливает для LinkCollectionNodesLength длину в элементах массива, необходимую для хранения сведений об узлах коллекции ссылок.

Дополнительные сведения см. в разделе Коллекции HID.

Требования

Требование Значение
Минимальная версия клиента Доступно в Windows 2000 и более поздних версиях Windows.
Целевая платформа Универсальное
Верхняя часть hidpi.h (включая Hidpi.h)
Библиотека Hidparse.lib
IRQL <= DISPATCH_LEVEL

См. также раздел

HIDP_CAPS

HIDP_LINK_COLLECTION_NODE

HidP_GetCaps

_HIDP_PREPARSED_DATA