função HidD_SetOutputReport (hidsdi.h)
A rotina HidD_SetOutputReport envia um relatório de saída para uma coleção 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.
Retornar valor
Se HidD_SetOutputReport for bem-sucedido, ele retornará TRUE; caso contrário, retornará FALSE. Use GetLastError para obter informações de erro estendidas.
Comentários
O ReportBufferLength correto é especificado pelo membro OutputReportByteLength da estrutura 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 a 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 a 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:
Para obter um exemplo de como preparar e um relatório HID e enviá-lo para uma 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 de IOCTL_HID_SET_OUTPUT_REPORT .
Requisitos
| Requisito | Valor |
|---|---|
| Cliente mínimo com suporte | Disponível no Windows XP e versões posteriores do Windows. |
| Plataforma de Destino | Universal |
| Cabeçalho | hidsdi.h (inclua Hidsdi.h) |
| Biblioteca | Hid.lib |
| DLL | Hid.dll |