HidP_GetSpecificButtonCaps función (hidpi.h)

  • Artículo

La rutina HidP_GetSpecificButtonCaps devuelve una matriz de funcionalidades de botón que describe todos los botones de control HID de una colección de nivel superior que cumplen los criterios de selección especificados.

Sintaxis

NTSTATUS HidP_GetSpecificButtonCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in]      USAGE                Usage,
  [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.

[in] UsagePage

Especifica una página de uso como criterios de búsqueda. Si UsagePage es distinto de cero, solo se devuelven los botones que especifican esta página de uso.

[in] LinkCollection

Especifica una colección de vínculos como criterios de búsqueda. Si LinkCollection es distinto de cero, solo se devuelven los botones que forman parte de esta colección de vínculos.

[in] Usage

Especifica un uso de HID como criterios de búsqueda. Si Usage es distinto de cero, solo se devolverán los botones que especifican este uso.

[out] ButtonCaps

Puntero a un búfer asignado por el autor de la llamada en el que la rutina devuelve 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 de elementos que la rutina devolvió realmente.

[in] PreparsedData

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

Valor devuelto

HidP_GetSpecificButtonCaps 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

El tamaño necesario de la matriz ButtonCaps se especifica mediante los miembros NumberXxxButtonCaps de una estructura de HIDP_CAPS de una colección de nivel superior.

Al llamar a HidP_GetSpecificButtonCaps, especificar cero para UsagePage, Usage y LinkCollection equivale a llamar a HidP_GetButtonCaps.

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_GetButtonCaps

HidP_GetCaps

_HIDP_PREPARSED_DATA