función HidP_GetData (hidpi.h)

  • Artículo

La rutina HidP_GetData devuelve, para un informe especificado, una matriz de estructuras de HIDP_DATA que identifican los índices de datos de todos los botones de control HID que están establecidos actualmente en ON (1) y los índices de datos y los datos asociados a todos los valores de control HID.

Sintaxis

NTSTATUS HidP_GetData(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [out]     PHIDP_DATA           DataList,
  [in, out] PULONG               DataLength,
  [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 HID ubicado en Informe.

[out] DataList

Especifica una matriz asignada por el autor de la llamada de HIDP_DATA estructuras que la rutina usa para devolver información sobre todos los botones que se establecen actualmente en ON y los datos asociados a los valores.

[in, out] DataLength

Especifica, en la entrada, el número de estructuras que contiene la matriz DataList asignada por el autor de la llamada. Especifica, en la salida, el número de controles para los que la rutina puede devolver datos, que incluye todos los botones que están establecidos actualmente en ON y todos los valores de control.

[in] PreparsedData

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

[in] Report

Puntero a un informe HID.

[in] ReportLength

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

Valor devuelto

HidP_GetData devuelve uno de los siguientes valores de estado:

Código devuelto Descripción
HIDP_STATUS_SUCCESS
 Se devolvieron correctamente todos los datos de control.
HIDP_STATUS_INVALID_REPORT_TYPE
 El tipo de informe especificado por ReportType no es válido
HIDP_STATUS_INVALID_PREPARSED_DATA
 Los datos preparados especificados por PreparsedData no son válidos .
HIDP_STATUS_INVALID_REPORT_LENGTH
 El tamaño, en bytes, del informe HID no es igual a la longitud especificada en la estructura HIDP_CAPS de la colección para el tipo de informe especificado.
HIDP_STATUS_REPORT_DOES_NOT_EXIST
 La colección de nivel superior no tiene un informe del tipo especificado.
HIDP_STATUS_BUFFER_TOO_SMALL
 La matriz DataList es demasiado pequeña para describir todos los botones, actualmente establecidos en ON y todos los valores del informe HID.

Comentarios

Las aplicaciones en modo de usuario y los controladores en modo kernel llaman a HidP_MaxDataListLength para determinar el número máximo posible de estructuras de HIDP_DATA que HidP_GetData pueden devolver.

HidP_GetData no devuelve datos para matrices de valores de uso.

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 (incluya Hidpi.h)
Library Hidparse.lib
IRQL <= DISPATCH_LEVEL

Consulte también

HIDP_DATA

HidP_MaxDataListLength

HidP_SetData

_HIDP_PREPARSED_DATA