HidP_GetUsageValue función (hidpi.h)

Artículo
08/07/2023

La rutina HidP_GetUsageValue extrae los datos asociados a un valor de control HID que coincide con los criterios de selección de un informe HID.

Sintaxis

NTSTATUS HidP_GetUsageValue(
  [in]  HIDP_REPORT_TYPE     ReportType,
  [in]  USAGE                UsagePage,
  [in]  USHORT               LinkCollection,
  [in]  USAGE                Usage,
  [out] PULONG               UsageValue,
  [in]  PHIDP_PREPARSED_DATA PreparsedData,
  [in]  PCHAR                Report,
  [in]  ULONG                ReportLength
);

Parámetros

[in] ReportType

Especifica un valor de enumerador HIDP_REPORT_TYPE que identifica el tipo de informe.

[in] UsagePage

Especifica la página de uso del valor.

[in] LinkCollection

Especifica la colección de vínculos que contiene el valor . Si LinkCollection es distinto de cero, la rutina solo busca el uso en esta colección de vínculos; de lo contrario, si LinkCollection es cero, la rutina busca el uso en la colección de nivel superior asociada a PreparsedData.

[in] Usage

Especifica el uso del valor.

[out] UsageValue

Puntero a un búfer en el que la rutina devuelve los datos de valor.

[in] PreparsedData

Puntero a los datos preparados de una colección de nivel superior.

[in] Report

Puntero a un informe que contiene valores.

[in] ReportLength

Especifica la longitud, en bytes, del informe ubicado en Informe.

Valor devuelto

HidP_GetUsageValue devuelve uno de los siguientes valores de estado:

Código devuelto	Descripción
HIDP_STATUS_SUCCESS	La rutina devolvió correctamente los datos de valor.
HIDP_INVALID_REPORT_LENGTH	La longitud del informe no es válida.
HIDP_INVALID_REPORT_TYPE	El tipo de informe especificado no es válido.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	La colección contiene un valor en la página de uso especificada en un informe del tipo especificado, pero no hay dichos usos en el informe especificado.
HIDP_STATUS_INVALID_PREPARSED_DATA	Los datos preparados no son válidos.
HIDP_STATUS_USAGE_NOT_FOUND	La colección no contiene un valor en la página de uso especificada en ningún informe del tipo de informe especificado.

Comentarios

HidP_GetUsageValue no firma ni escala el valor. Para extraer un valor con signo, use HidP_GetScaledUsageValue. Para asignar manualmente el bit de signo, la posición del bit de signo se puede determinar a partir de la información de la estructura HIDP_VALUE_CAPS de un valor.

HidP_GetUsageValue está diseñado para extraer un valor de uso para un uso cuyo recuento de informes es 1. Si el uso especificado tiene un recuento de informes mayor que 1, el uso forma parte de una matriz de valores de uso. HidP_GetUsageValue solo devuelve el primer elemento de datos de una matriz de valores de uso. Para extraer todos los elementos de datos de una matriz de valores de uso, use HidP_GetUsageValueArray.

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