função HidD_SetOutputReport (hidsdi.h)

A rotina de HidD_SetOutputReport envia um relatório de saída para uma coleção de de nível superior.

Use essa rotina apenas para definir o estado atual de uma coleção. Alguns dispositivos podem não dar suporte a essa rotina e ficarão sem resposta se essa rotina for usada. Para obter mais informações, consulte Envio de relatórios HID por aplicativos User-Mode.

Sintaxe

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

Parâmetros

[in] HidDeviceObject

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

[in] ReportBuffer

Ponteiro para um buffer de relatório de saída alocado pelo chamador que o chamador usa para especificar uma ID de relatório.

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 saída mais um byte adicional que especifica uma ID de relatório diferente de zero. Se a ID do relatório não for usada, o valor da ID será zero.

Valor de retorno

Se HidD_SetOutputReport for bem-sucedido, ele retornará verdadeiro; caso contrário, ele retornará FALSE . Use GetLastError para obter informações de erro estendidas.

Observações

O ReportBufferLength correto é especificado pelo membro OutputReportByteLength 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_SetOutputReport, 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 saída é referenciado pelo parâmetro ReportBuffer. Dependendo da ID do relatório, o chamador prepara o relatório chamando uma das seguintes funções:
  • HidP_SetData
  • HidP_SetScaledUsageValue
  • HidP_SetUsages
  • HidP_SetUsageValue
  • HidP_SetUsageValueArray

Para obter um exemplo de como preparar e um relatório HID e enviá-lo para um de coleção de nível superior, consulte o aplicativo de exemplo HClient.

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

Requisitos

Consulte também

• enviar relatórios HID
• interpretando relatórios HID
• HidD_GetFeature
• HidD_GetInputReport
• HidD_SetFeature
• HIDP_CAPS
• HidP_GetCaps
• IOCTL_HID_GET_FEATURE
• IOCTL_HID_GET_INPUT_REPORT
• IOCTL_HID_SET_FEATURE
• IOCTL_HID_SET_OUTPUT_REPORT