función HidP_UnsetUsages (hidpi.h)

La rutina HidP_UnsetUsages establece los usos de botón de control HID especificados OFF (cero) en un informe HID.

Sintaxis

NTSTATUS HidP_UnsetUsages(
  [in]           HIDP_REPORT_TYPE     ReportType,
  [in]           USAGE                UsagePage,
  [in, optional] USHORT               LinkCollection,
  [in, out]      PUSAGE               UsageList,
  [in, out]      PULONG               UsageLength,
  [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 ubicado en Informe.

[in] UsagePage

Especifica la página de uso de los usos especificados por UsageList.

[in, optional] LinkCollection

Especifica la colección de vínculos que contiene los usos. Si LinkCollection no es cero, la rutina solo establece los usos, si existen, en esta colección de vínculos. Si LinkCollection es cero, la rutina establece el primer uso para cada uso que encuentra en la colección de nivel superior asociada a PreparsedData.

[in, out] UsageList

Puntero a la matriz de usos que se va a establecer en OFF.

[in, out] UsageLength

Especifica, en la entrada, el número de usos en UsageList. Consulte la sección Comentarios para obtener información sobre el valor de salida.

[in] PreparsedData

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

[in] Report

Puntero a un informe.

[in] ReportLength

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

Valor devuelto

HidP_UnsetUsages devuelve HIDP_STATUS_SUCCESS si se establece correctamente en OFF todos los usos de UsageList.

HidP_UnsetUsages devuelve uno de los siguientes valores de estado si uno de los parámetros de entrada no es válido:

Código devuelto	Descripción
HIDP_STATUS_INVALID_PREPARSED_DATA	Los datos preparados especificados por PreparsedData no son válidos .
HIDP_STATUS_INVALID_REPORT_LENGTH	La longitud del informe no es válida.
HIDP_STATUS_INVALID_REPORT_TYPE	El tipo de informe no es válido.
HIDP_STATUS_REPORT_DOES_NOT_EXIST	La colección no contiene un informe del tipo especificado.

 

HidP_UnsetUsages devuelve uno de los siguientes valores de estado si no se pudo establecer en OFF uno de los usos de UsageList:

Código devuelto	Descripción
HIDP_STATUS_BUTTON_NOT_PRESSED	Ya se ha establecido un uso en OFF.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Un uso no está incluido en el informe especificado, pero está incluido en otro informe del tipo especificado.
HIDP_STATUS_USAGE_NOT_FOUND	La rutina no encontró un uso en ningún informe del tipo especificado.

Comentarios

HidP_UnsetUsages establece UsageLength de la siguiente manera:

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_SetButtons

HidP_SetData

HidP_SetUsages

HidP_UnsetButtons

_HIDP_PREPARSED_DATA