HidP_SetUsages función (hidpi.h)

Artículo
08/07/2023

La rutina HidP_SetUsages establece los botones de control HID especificados ON (1) en un informe HID.

Sintaxis

NTSTATUS HidP_SetUsages(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in, out] PUSAGE               UsageList,
  [in, out] PULONG               UsageLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [in]      PCHAR                Report,
  [in]      ULONG                ReportLength
);

Parámetros

[in] ReportType

Especifica un valor de enumerador HIDP_REPORT_TYPE que indica el tipo de informe ubicado en Informe.

[in] UsagePage

Especifica la página de uso de los usos especificados por UsageList.

[in] LinkCollection

Especifica la colección de vínculos que contiene los usos. Si LinkCollection es distinto de cero, la rutina solo establece los usos, si existen, en esta colección de vínculos. Si LinkCollection es cero, la rutina establece el primer uso de cada uso especificado en la colección de nivel superior asociada a PreparsedData.

[in, out] UsageList

Puntero a la matriz de usos.

[in, out] UsageLength

Especifica, en la entrada, el número de usos de UsageList. Consulte la sección Comentarios para obtener información sobre el valor de salida.

[in] PreparsedData

Puntero a los datos preparados de la colección de nivel superior asociada al informe ubicado en Informe.

[in] Report

Puntero a un informe.

[in] ReportLength

Especifica el tamaño, en bytes, del informe ubicado en Report, que debe ser igual a la longitud del informe para el tipo de informe especificado que HidP_GetCaps devuelve en la estructura HIDP_CAPS de una colección.

Valor devuelto

HidP_SetUsages devuelve uno de los siguientes valores de estado:

Código devuelto	Descripción
HIDP_STATUS_SUCCESS	La rutina establece correctamente el valor de uso.
HIDP_STATUS_BUFFER_TOO_SMALL	No se puede establecer un uso en una matriz de botones porque la matriz ya está totalmente establecida.
HIDP_STATUS_INVALID_REPORT_LENGTH	La longitud del informe no es válida.
HIDP_STATUS_INVALID_REPORT_TYPE	El tipo de informe especificado no es válido.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Un uso no existe en el informe especificado, pero existe en un informe diferente del tipo especificado.
HIDP_STATUS_INVALID_PREPARSED_DATA	Los datos preparados no son válidos.
HIDP_STATUS_USAGE_NOT_FOUND	Un uso no existe en ningún informe del tipo de informe especificado.

Comentarios

Si HidP_SetUsages no puede establecer un uso en UsageList, la rutina establece UsageLength en el índice del uso que no se pudo establecer y devuelve un valor de estado que indica el error.

Para obtener más información, consulte Colecciones HID.

Requisitos

Requisito	Value
Cliente mínimo compatible	Disponible en Windows 2000 y versiones posteriores de Windows.
Plataforma de destino	Universal
Encabezado	hidpi.h (include Hidpi.h)
Library	Hidparse.lib
IRQL	<= DISPATCH_LEVEL