función HidD_SetOutputReport (hidsdi.h)
La rutina HidD_SetOutputReport envía un informe de salida a una colección de nivel superior.
Use esta rutina solo para establecer el estado actual de una colección. Es posible que algunos dispositivos no admitan esta rutina y no responderán si se usa esta rutina. Para obtener más información, consulte Envío de informes HID por User-Mode Aplicaciones.
Sintaxis
BOOLEAN HidD_SetOutputReport(
[in] HANDLE HidDeviceObject,
[in] PVOID ReportBuffer,
[in] ULONG ReportBufferLength
);
Parámetros
[in] HidDeviceObject
Identificador abierto a una colección de nivel superior.
[in] ReportBuffer
Puntero a un búfer de informe de salida asignado por el autor de la llamada que usa para especificar un identificador de informe.
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 salida más un byte adicional que especifique un identificador de informe distinto de cero. Si no se usa el identificador de informe, el valor de id. es cero.
Valor devuelto
Si HidD_SetOutputReport se realiza correctamente, devuelve TRUE; de lo contrario, devuelve FALSE. Use GetLastError para obtener información de error extendida.
Comentarios
ReportBufferLength correcto se especifica mediante el miembro OutputReportByteLength de una estructura de HIDP_CAPS de la colección de nivel superior devuelta desde HidP_GetCaps llamada.
Antes de llamar a la rutina HidD_SetOutputReport , 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 parámetro ReportBuffer hace referencia al informe de salida. Según el identificador de informe, el autor de la llamada prepara el informe llamando a una de las funciones siguientes:
Para obtener un ejemplo de cómo preparar y enviar un informe HID a una colección de nivel superior, consulte la aplicación de ejemplo HClient .
Solo las aplicaciones en modo de usuario pueden llamar a HidD_SetOutputReport. Los controladores en modo kernel pueden usar una solicitud de IOCTL_HID_SET_OUTPUT_REPORT .
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 |