função HidP_GetUsageValue (hidpi.h)

Artigo
02/26/2024

A rotina HidP_GetUsageValue extrai os dados associados a um valor de controle HID que corresponde aos critérios de seleção em um relatório HID.

Sintaxe

NTSTATUS HidP_GetUsageValue(
  [in]  HIDP_REPORT_TYPE     ReportType,
  [in]  USAGE                UsagePage,
  [in]  USHORT               LinkCollection,
  [in]  USAGE                Usage,
  [out] PULONG               UsageValue,
  [in]  PHIDP_PREPARSED_DATA PreparsedData,
  [in]  PCHAR                Report,
  [in]  ULONG                ReportLength
);

Parâmetros

[in] ReportType

Especifica um valor de enumerador HIDP_REPORT_TYPE que identifica o tipo de relatório.

[in] UsagePage

Especifica a página de uso do valor.

[in] LinkCollection

Especifica a coleção de link que contém o valor . Se LinkCollection não for zero, a rotina só pesquisa o uso nesta coleção de links; caso contrário, se LinkCollection for zero, a rotina procurará o uso na coleção de nível superior associada a PreparsedData.

[in] Usage

Especifica o uso do valor.

[out] UsageValue

Ponteiro para um buffer no qual a rotina retorna os dados de valor.

[in] PreparsedData

Ponteiro para os dados pré-preparados de uma coleção de nível superior.

[in] Report

Ponteiro para um relatório que contém valores.

[in] ReportLength

Especifica o comprimento, em bytes, do relatório localizado em Relatório.

Retornar valor

HidP_GetUsageValue retorna um dos seguintes valores de status:

Código de retorno	Descrição
HIDP_STATUS_SUCCESS	A rotina retornou com êxito os dados de valor.
HIDP_INVALID_REPORT_LENGTH	O comprimento do relatório não é válido.
HIDP_INVALID_REPORT_TYPE	O tipo de relatório especificado não é válido.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	A coleção contém um valor na página de uso especificada em um relatório do tipo especificado, mas não há esses usos no relatório especificado.
HIDP_STATUS_INVALID_PREPARSED_DATA	Os dados pré-parados não são válidos.
HIDP_STATUS_USAGE_NOT_FOUND	A coleção não contém um valor na página de uso especificada em nenhum relatório do tipo de relatório especificado.

Comentários

HidP_GetUsageValue não assina nem dimensiona o valor. Para extrair um valor assinado, use HidP_GetScaledUsageValue. Para atribuir manualmente o bit de sinal, a posição do bit de sinal pode ser determinada a partir das informações na estrutura HIDP_VALUE_CAPS de um valor.

HidP_GetUsageValue foi projetado para extrair um valor de uso para um uso cuja contagem de relatórios é 1. Se o uso especificado tiver uma contagem de relatório maior que 1, o uso será parte de uma matriz de valor de uso. HidP_GetUsageValue retorna apenas o primeiro item de dados em uma matriz de valor de uso. Para extrair todos os itens de dados em uma matriz de valor de uso, use HidP_GetUsageValueArray.

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