função HidP_GetData (hidpi.h)

  • Artigo

A rotina HidP_GetData retorna, para um relatório especificado, uma matriz de estruturas HIDP_DATA que identificam os índices de dados de todos os botões de controle HID que estão atualmente definidos como ON (1) e os índices de dados e dados associados a todos os valores de controle HID.

Sintaxe

NTSTATUS HidP_GetData(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [out]     PHIDP_DATA           DataList,
  [in, out] PULONG               DataLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [in]      PCHAR                Report,
  [in]      ULONG                ReportLength
);

Parâmetros

[in] ReportType

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

[out] DataList

Especifica uma matriz alocada por chamador de HIDP_DATA estruturas que a rotina usa para retornar informações sobre todos os botões que estão atualmente definidos como ON e os dados associados aos valores.

[in, out] DataLength

Especifica, na entrada, o número de estruturas que a matriz DataList alocada pelo chamador contém. Especifica, na saída, o número de controles para os quais a rotina pode retornar dados, que inclui todos os botões que estão atualmente definidos como ON e todos os valores de controle.

[in] PreparsedData

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

[in] Report

Ponteiro para um relatório HID.

[in] ReportLength

Especifica o tamanho, em bytes, do relatório HID localizado em Relatório, que deve ser igual ao comprimento do relatório para o tipo de relatório especificado retornado por HidP_GetCaps na estrutura HIDP_CAPS da coleção.

Retornar valor

HidP_GetData retorna um dos seguintes valores de status:

Código de retorno Descrição
HIDP_STATUS_SUCCESS
 Todos os dados de controle foram retornados com êxito.
HIDP_STATUS_INVALID_REPORT_TYPE
 O tipo de relatório especificado por ReportType não é válido
HIDP_STATUS_INVALID_PREPARSED_DATA
 Os dados pré-pars especificados por PreparsedData não são válidos
HIDP_STATUS_INVALID_REPORT_LENGTH
 O tamanho, em bytes, do relatório HID não é igual ao comprimento especificado na estrutura HIDP_CAPS da coleção para o tipo de relatório especificado.
HIDP_STATUS_REPORT_DOES_NOT_EXIST
 A coleção de nível superior não tem um relatório do tipo especificado.
HIDP_STATUS_BUFFER_TOO_SMALL
 A matriz DataList é muito pequena para descrever todos os botões, atualmente definidos como ON e todos os valores no relatório HID.

Comentários

Aplicativos no modo de usuário e drivers de modo kernel chamam HidP_MaxDataListLength para determinar o número máximo possível de estruturas de HIDP_DATA que HidP_GetData podem retornar.

HidP_GetData não retorna dados para matrizes de valor de uso.

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_DATA

HidP_MaxDataListLength

HidP_SetData

_HIDP_PREPARSED_DATA