HidP_GetUsagesEx

9/8/2008

Essa função retorna uma lista de usos de botão controle HID que estejam definidos como em um relatório HID.

Syntax

NTSTATUS HidP_GetUsagesEx(
  HIDP_REPORT_TYPE ReportType,
  USHORT LinkCollection,
  PUSAGE_AND_PAGE ButtonList,
  ULONG* UsageLength,
  PHIDP_PREPARSED_DATA PreparsedData,
  PCHAR Report,
  ULONG ReportLength
);

Parameters

• ReportType
  [no] HIDP_REPORT_TYPE valor enumerador que identifica o tipo relatório.

• LinkCollection
  [no] Vincular coleção de usos de botão. Se LinkCollection é diferente de zero, a função só retornará informações sobre os botões que contém essa coleção link; caso contrário, se LinkCollection for zero, a função retorna informações sobre todos os botões de de alto nível coleção associado com PreparsedData.

• ButtonList
  [out] Ponteiro para uma reserva Caller-allocated que essa função usa para retornar o uso e uso identificadores página para cada botão que estiver configurado para Ativado (um).

• UsageLength
  [in, Out] Na entrada, o comprimento em elementos de matriz a ButtonList reserva. Na saída, o número de usos que estão atualmente definidos como no relatório especificado.

• PreparsedData
  [no] Ponteiro para uma de alto nível preparsed da coleção dados.

• Relatório
  [no] Ponteiro para um relatório que contém dados botão.

• ReportLength
  [no] Comprimento, em bytes, do relatório localizado em Relatório.

Return Value

A seguinte tabela mostra os possíveis valores de retorno.

Valor	Descrição
HIDP_STATUS_SUCCESS	Função retornado com êxito todos os usos botão que estejam definidos como ON.
HIDP_INVALID_REPORT_LENGTH	Comprimento de relatório não é válido.
HIDP_INVALID_REPORT_TYPE	Especificado tipo relatório não é válido.
HIDP_STATUS_BUFFER_TOO_SMALL	UsageList reserva é muito pequeno para conter todos os usos atualmente configurados para ativado no relatório especificado.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Relatório contém uma coleção com botões de página especificado uso, mas há não tais usos no relatório.
HIDP_STATUS_INVALID_PREPARSED_DATA	Dados preparsed não não válido.

Remarks

Os termos botão e o uso são usados como sinônimo.

Chamar clientes HID HidP_MaxUsageListLength Para determinar o número máximo de botões que essa função pode retornar para um tipo relatório especificado. Como alternativa, aplicativos ou drivers podem chamar HidP_GetUsagesEx e defina UsageList Para zero para retornar o exigido comprimento em UsageLength.

Aplicativos ou drivers determinam o exigido comprimento relatório a partir de XxxReportByteLength Membros em uma de alto nível da coleção HIDP_CAPS estrutura.

Requirements

Header	hidpi.h
Library	Hidparse_lib.lib
Windows Embedded CE	Windows CE .NET 4.2 and later

See Also

Reference

HIDP_CAPS
HidP_GetButtons
HidP_GetButtonsEx
HidP_GetCaps
HidP_GetScaledUsageValue
HidP_GetUsageValue
HidP_GetUsageValueArray
HidP_MaxUsageListLength
HIDP_REPORT_TYPE
USAGE_AND_PAGE