Compartilhar via

função HidD_GetInputReport (hidsdi.h)

  • Artigo

A rotina de HidD_GetInputReport retorna um relatório de entrada de uma coleção de de nível superior.

Use essa rotina apenas para obter o estado atual de uma coleção. Se um aplicativo tentar usar essa rotina para obter continuamente relatórios de entrada, os relatórios poderão ser perdidos. Para obter mais informações, consulte Obtendo relatórios HID por aplicativos de modo de usuário.

Sintaxe

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

Parâmetros

[in] HidDeviceObject

Um identificador aberto para uma coleção de nível superior.

[out] ReportBuffer

Ponteiro para um buffer de relatório de entrada alocado pelo chamador que o chamador usa para especificar uma ID de relatório HID e HidD_GetInputReport usa para retornar o relatório de entrada especificado.

Para obter mais informações sobre esse parâmetro, consulte a seção Comentários.

[in] ReportBufferLength

O tamanho do buffer de relatório em bytes. O buffer de relatório deve ser grande o suficiente para manter o relatório de entrada mais um byte adicional que especifica uma ID de relatório. Se a ID do relatório não for usada, o valor da ID será zero.

Valor de retorno

HidD_GetInputReport retornará TRUE se tiver êxito; caso contrário, ele retornará FALSE . Use GetLastError para obter informações de erro estendidas.

Observações

O ReportBufferLength correto é especificado pelo membro InputReportByteLength de da estrutura de HIDP_CAPS de uma coleção de nível superior retornada de HidP_GetCaps chamada.

Antes de chamar a rotina de HidD_GetInputReport, o chamador deve fazer o seguinte:

  • Se o coleção de nível superior incluir IDs de relatório, o chamador deverá definir o primeiro byte do parâmetro ReportBuffer como uma ID de relatório diferente de zero.
  • Se o coleção de nível superior não incluir IDs de relatório, o chamador deverá definir o primeiro byte do parâmetro ReportBuffer como zero.

O relatório de entrada é retornado no parâmetro ReportBuffer. Dependendo da ID do relatório, o chamador analisa o relatório chamando uma das seguintes funções:

Para obter um exemplo de como analisar um relatório HID, consulte o aplicativo de exemplo do HClient.

Somente aplicativos no modo de usuário podem chamar HidD_GetInputReport. Os drivers no modo kernel podem usar uma solicitação IOCTL_HID_GET_INPUT_REPORT.

Para obter mais informações, consulte Interpretando relatórios HID.

Requisitos

Requisito Valor
de cliente com suporte mínimo Disponível no Windows XP e versões posteriores do Windows.
da Plataforma de Destino Universal
cabeçalho hidsdi.h (inclua Hidsdi.h)
biblioteca Hid.lib
de DLL Hid.dll

Consulte também