función HidD_GetInputReport (hidsdi.h)

  • Artículo

La rutina HidD_GetInputReport devuelve un informe de entrada de una colección de nivel superior.

Use esta rutina solo para obtener el estado actual de una colección. Si una aplicación intenta usar esta rutina para obtener continuamente informes de entrada, se pueden perder los informes. Para obtener más información, vea Obtener informes HID por aplicaciones en modo de usuario.

Sintaxis

BOOLEAN HidD_GetInputReport(
  [in]  HANDLE HidDeviceObject,
  [out] PVOID  ReportBuffer,
  [in]  ULONG  ReportBufferLength
);

Parámetros

[in] HidDeviceObject

Identificador abierto a una colección de nivel superior.

[out] ReportBuffer

Puntero a un búfer de informe de entrada asignado por el autor de la llamada que usa para especificar un identificador de informe HID y HidD_GetInputReport usa para devolver el informe de entrada especificado.

Para obtener más información sobre este parámetro, vea la sección Comentarios.

[in] ReportBufferLength

Tamaño del búfer del informe en bytes. El búfer del informe debe ser lo suficientemente grande como para contener el informe de entrada más un byte adicional que especifique un identificador de informe. Si no se usa el identificador de informe, el valor de id. es cero.

Valor devuelto

HidD_GetInputReport devuelve TRUE si se realiza correctamente; de lo contrario, devuelve FALSE. Use GetLastError para obtener información de error extendida.

Comentarios

El miembro InputReportByteLength correcto de una colección de nivel superior especifica el miembro InputReportByteLength de la estructura HIDP_CAPS de una colección de nivel superior devuelta desde HidP_GetCaps llamada.

Antes de llamar a la rutina HidD_GetInputReport , el autor de la llamada debe hacer lo siguiente:

  • Si la colección de nivel superior incluye identificadores de informe, el autor de la llamada debe establecer el primer byte del parámetro ReportBuffer en un identificador de informe distinto de cero.
  • Si la colección de nivel superior no incluye identificadores de informe, el autor de la llamada debe establecer el primer byte del parámetro ReportBuffer en cero.

El informe de entrada se devuelve en el parámetro ReportBuffer . Según el identificador de informe, el autor de la llamada analiza el informe llamando a una de las funciones siguientes:

Para obtener un ejemplo de cómo analizar un informe HID, consulte la aplicación de ejemplo HClient .

Solo las aplicaciones en modo de usuario pueden llamar a HidD_GetInputReport. Los controladores en modo kernel pueden usar una solicitud de IOCTL_HID_GET_INPUT_REPORT.

Para obtener más información, consulte Interpretación de informes HID.

Requisitos

Requisito Value
Cliente mínimo compatible Disponible en Windows XP y versiones posteriores de Windows.
Plataforma de destino Universal
Encabezado hidsdi.h (include Hidsdi.h)
Library Hid.lib
Archivo DLL Hid.dll

Consulte también