Compartir a través de

HidP_GetButtonCaps función (hidpi.h)

  • Artículo

La rutina HidP_GetButtonCaps devuelve una matriz de funcionalidad de botón que describe todos los botones de control HID de una colección de nivel superior para un tipo especificado de informe HID.

Sintaxis

NTSTATUS HidP_GetButtonCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [out]     PHIDP_BUTTON_CAPS    ButtonCaps,
  [in, out] PUSHORT              ButtonCapsLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData
);

Parámetros

[in] ReportType

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

[out] ButtonCaps

Puntero a un búfer asignado por el autor de la llamada que la rutina usa para devolver una matriz de funcionalidad de botón para el tipo de informe especificado.

[in, out] ButtonCapsLength

Especifica la longitud de la entrada, en los elementos de matriz, del búfer proporcionado en ButtonCaps. En la salida, este parámetro se establece en el número real de elementos que devuelve la rutina.

[in] PreparsedData

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

Valor devuelto

HidP_GetButtonCaps devuelve uno de los siguientes valores de estado:

Código devuelto Descripción
HIDP_STATUS_SUCCESS
 La rutina devolvió correctamente los datos de funcionalidad.
HIDP_STATUS_INVALID_PREPARSED_DATA
 Los datos preparados no son válidos.

Comentarios

HidP_GetButtonCaps devuelve la funcionalidad de todos los botones de una colección de nivel superior para un tipo de informe especificado.

ButtonCapsLength debe establecerse en el valor del miembro NumberXxxButtonCaps de la estructura HIDP_CAPS devuelta por HidP_GetCaps, donde Xxx especifica el tipo de informe.

Para obtener un subconjunto de funcionalidades de botón, seleccionadas por uso, página de uso o colección de vínculos, use HidP_GetSpecificButtonCaps.

Para obtener más información sobre la funcionalidad de una colección, vea Obtener información de recopilación.

Consulte también 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 PASSIVE_LEVEL

Consulte también

HIDP_BUTTON_CAPS

HidP_GetCaps

HidP_GetSpecificButtonCaps

_HIDP_PREPARSED_DATA