função HidP_InitializeReportForID (hidpi.h)

  • Artigo

A rotina HidP_InitializeReportForID inicializa um relatório HID.

Sintaxe

NTSTATUS HidP_InitializeReportForID(
  [in]  HIDP_REPORT_TYPE     ReportType,
  [in]  UCHAR                ReportID,
  [in]  PHIDP_PREPARSED_DATA PreparsedData,
  [out] PCHAR                Report,
  [in]  ULONG                ReportLength
);

Parâmetros

[in] ReportType

Especifica um enumerador HIDP_REPORT_TYPE que indica o tipo de relatório HID localizado em Relatório.

[in] ReportID

Especifica uma ID de relatório.

[in] PreparsedData

Ponteiro para os dados pré-preparados da coleção de nível superior associada ao relatório HID localizado em Relatório.

[out] Report

Ponteiro para o buffer alocado pelo chamador que contém o relatório HID que HidP_InitializeReportForID inicializa.

[in] ReportLength

Especifica o tamanho, em bytes, do relatório HID localizado em Relatório. ReportLength deve ser igual ao comprimento do relatório da coleção para o tipo de relatório especificado, conforme especificado pelos membros XxxReportByteLength da estrutura de HIDP_CAPS de uma coleção.

Retornar valor

HidP_InitializeReportForID retorna um dos seguintes valores de status:

Código de retorno Descrição
HIDP_STATUS_SUCCESS
 O relatório foi inicializado com êxito.
HIDP_STATUS_INVALID_PREPARSED_DATA
 Os dados pré-parados não são válidos.
HIDP_STATUS_INVALID_REPORT_LENGTH
 O comprimento especificado do relatório não é igual ao comprimento do relatório da coleção para o tipo de relatório especificado.
HIDP_STATUS_INVALID_REPORT_TYPE
 O tipo de relatório não é válido.
HIDP_STATUS_REPORT_DOES_NOT_EXIST
 A ID do relatório especificada não é válida.

Comentários

Inicializar um relatório HID define todos os dados de controle como zero ou o valor nulo de um controle, conforme definido pelo padrão USB HID. (Enviar ou receber um valor nulo indica que o valor atual de um controle não deve ser modificado.)

HidP_InitializeReportForID faz o seguinte:

  • Define como zero os campos de bits de todos os botões e valores sem valores nulos.
  • Define o campo de bits de todos os controles com valores nulos para o valor nulo correspondente.
Para obter mais informações, consulte Coleções HID.

Requisitos

Requisito Valor
Cliente mínimo com suporte Disponível no Windows 2000 e versões posteriores do Windows.
Plataforma de Destino Universal
Cabeçalho hidpi.h (inclua Hidpi.h)
Biblioteca Hidparse.lib
IRQL <= DISPATCH_LEVEL

Confira também

HIDP_CAPS

HIDP_REPORT_TYPE

HidP_GetCaps

_HIDP_PREPARSED_DATA