HidP_InitializeReportForID función (hidpi.h)

La rutina HidP_InitializeReportForID inicializa un informe HID.

Sintaxis

NTSTATUS HidP_InitializeReportForID(
  [in]  HIDP_REPORT_TYPE     ReportType,
  [in]  UCHAR                ReportID,
  [in]  PHIDP_PREPARSED_DATA PreparsedData,
  [out] PCHAR                Report,
  [in]  ULONG                ReportLength
);

Parámetros

[in] ReportType

Especifica un enumerador de HIDP_REPORT_TYPE que indica el tipo de informe HID ubicado en Report.

[in] ReportID

Especifica un identificador de informe.

[in] PreparsedData

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

[out] Report

Puntero al búfer asignado por el autor de la llamada que contiene el informe HID que HidP_InitializeReportForID inicializa.

[in] ReportLength

Especifica el tamaño, en bytes, del informe HID ubicado en Informe. ReportLength debe ser igual a la longitud del informe de la colección para el tipo de informe especificado, según lo especificado por los miembros XxxReportByteLength de la estructura HIDP_CAPS de una colección.

Valor devuelto

HidP_InitializeReportForID devuelve uno de los siguientes valores de estado:

Código devuelto	Descripción
HIDP_STATUS_SUCCESS	El informe se inicializó correctamente.
HIDP_STATUS_INVALID_PREPARSED_DATA	Los datos preparados no son válidos.
HIDP_STATUS_INVALID_REPORT_LENGTH	La longitud especificada del informe no es igual a la longitud del informe de la colección para el tipo de informe especificado.
HIDP_STATUS_INVALID_REPORT_TYPE	El tipo de informe no es válido.
HIDP_STATUS_REPORT_DOES_NOT_EXIST	El identificador de informe especificado no es válido.

Comentarios

Al inicializar un informe HID, se establecen todos los datos de control en cero o en el valor NULL de un control, tal y como se define en el estándar USB HID. (Enviar o recibir un valor NULL indica que no se debe modificar el valor actual de un control).

HidP_InitializeReportForID hace lo siguiente:

• Establece en cero los campos de bits de todos los botones y valores sin valores NULL.
• Establece el campo de bits de todos los controles con valores NULL en su valor NULL correspondiente.

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

Consulte también

HIDP_CAPS

HIDP_REPORT_TYPE

HidP_GetCaps

_HIDP_PREPARSED_DATA