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

Статья
02/07/2025

Подпрограмма HidP_GetUsagesEx возвращает список всех кнопки управления HID использования, для которых задано значение ON в отчете HID.

Синтаксис

NTSTATUS HidP_GetUsagesEx(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USHORT               LinkCollection,
  [in, out] PUSAGE_AND_PAGE      ButtonList,
  [in, out] ULONG                *UsageLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [in]      PCHAR                Report,
  [in]      ULONG                ReportLength
);

Параметры

[in] ReportType

Задает значение перечислителя HIDP_REPORT_TYPE, определяющее тип отчета.

[in] LinkCollection

Указывает коллекцию ссылок использования кнопки. Если LinkCollection ненулевое, подпрограмма возвращает только сведения о кнопках, содержащих эту коллекцию ссылок; В противном случае, если LinkCollection равно нулю, подпрограмма возвращает сведения обо всех кнопках коллекции коллекции верхнего уровня, связанной с PreparsedData.

[in, out] ButtonList

Указатель на выделенный вызывающим буфером, который используется для возврата страницы использования и использования, идентификаторов для каждой кнопки, которая имеет значение ON (1).

[in, out] UsageLength

Указывает для входных данных длину в элементах массива ButtonList буфера. Указывает в выходных данных число используемых в данный момент значениях ON в указанном отчете.

[in] PreparsedData

Указатель на предварительно подготовленныхданных коллекции верхнего уровня.

[in] Report

Указатель на отчет, содержащий данные кнопки.

[in] ReportLength

Указывает длину отчета в байтах, расположенного в отчете.

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

HidP_GetUsagesEx возвращает одно из следующих значений состояния:

Возвращаемый код	Описание
HIDP_STATUS_SUCCESS	Подпрограмма успешно вернула все параметры использования кнопки, заданные в on.
HIDP_INVALID_REPORT_LENGTH	Длина отчета недопустима.
HIDP_INVALID_REPORT_TYPE	Указанный тип отчета недопустим.
HIDP_STATUS_BUFFER_TOO_SMALL	Буфер UsageList слишком мал, чтобы сохранить все значения использования, заданные в настоящее время в указанном отчете.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Коллекция содержит кнопки в отчете указанного типа, но в указанном отчете нет таких действий.
HIDP_STATUS_INVALID_PREPARSED_DATA	Предварительно подготовленные данные недопустимы.

Замечания

Приложения в пользовательском режиме и драйверы в режиме ядра вызывают HidP_MaxUsageListLength, чтобы определить максимальное количество кнопок, возвращаемых для указанного типа отчета. Кроме того, приложения или драйверы могут вызывать HidP_GetUsagesEx и задавать (*UsageLength) равным нулю, чтобы вернуть необходимую длину в UsageLength. Другими словами, UsageLength должен быть допустимым указателем, указывающим на значение ULONG 0, чтобы получить необходимую длину.

Приложения или драйверы определяют необходимую длину отчета из XxxreportByteLength членов коллекции HIDP_CAPS верхнего уровня.

Дополнительные сведения см. в коллекциях HID.

Требования

Требование	Ценность
минимальные поддерживаемые клиентские	Доступно в Windows 2000 и более поздних версиях Windows.
целевая платформа	Всеобщий
заголовка	hidpi.h (include Hidpi.h)
библиотеки	Hidparse.lib
IRQL	<= DISPATCH_LEVEL