Compartilhar via


função HidP_GetScaledUsageValue (hidpi.h)

A rotina HidP_GetScaledUsageValue retorna o resultado assinado e dimensionado de um valor de controle HID extraído de um relatório HID.

Sintaxe

NTSTATUS HidP_GetScaledUsageValue(
  [in]  HIDP_REPORT_TYPE     ReportType,
  [in]  USAGE                UsagePage,
  [in]  USHORT               LinkCollection,
  [in]  USAGE                Usage,
  [out] PLONG                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 HID que contém o valor de uso de HID .

[in] UsagePage

Especifica a página de uso do valor a ser extraído.

[in] LinkCollection

Especifica o identificador da coleção de link do valor a ser extraído. Um valor LinkCollection de zero identifica a coleção de nível superior.

[in] Usage

Especifica o uso do valor a ser extraído.

[out] UsageValue

Ponteiro para o buffer no qual a rotina retorna o valor assinado e dimensionado.

[in] PreparsedData

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

[in] Report

Ponteiro para o relatório que contém o uso.

[in] ReportLength

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

Valor de retorno

HidP_GetScaledUsageValue retorna um dos seguintes valores de status:

Código de retorno Descrição
HIDP_STATUS_SUCCESS A rotina retornou o valor com êxito.
HIDP_STATUS_INVALID_REPORT_TYPE O tipo de relatório especificado não é válido.
HIDP_STATUS_INVALID_REPORT_LENGTH O comprimento do relatório especificado não é válido.
HIDP_STATUS_BAD_LOG_PHY_VALUES A coleção retornou um valor lógico ou físico ilegal. Para extrair o valor retornado pela coleção, chame HidP_GetUsageValue.
HIDP_STATUS_NULL O estado atual do valor dimensionado da coleção é menor que o mínimo lógico ou é maior que o máximo lógico e o valor dimensionado tem um estado NULL.
HIDP_STATUS_VALUE_OUT_OF_RANGE O estado atual dos dados de valor dimensionado da coleção é menor que o mínimo lógico ou é maior que o máximo lógico.
HIDP_STATUS_USAGE_NOT_FOUND O uso, a página de uso ou a coleção de links especificados não podem ser encontrados em nenhum relatório compatível com a coleção de nível superior especificada.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID O valor especificado não está contido no relatório especificado, mas está contido em outro relatório compatível com a coleção de nível superior especificada.

Observações

Valores dimensionados referem-se à saída ajustada de dados HID brutos, que são modificados com base em parâmetros específicos, como a confidencialidade e o intervalo do dispositivo. Esse ajuste permite uma interpretação mais significativa dos dados em relação ao uso pretendido do dispositivo.

Para entender melhor como os relatórios HID são interpretados e a importância dos valores dimensionados, consulte Interpretando relatórios HID.

Os buffers alocados pelo chamador fornecidos em PreparsedData, UsageValuee Report devem ser alocados do pool nãopagado.

Os aplicativos no modo de usuário e os drivers de modo kernel devem usar HidP_GetUsageValueArray para extrair dados para uma matriz de valor de uso .

Se a rotina retornar o status HIDP_STATUS_BAD_LOG_PHY_VALUES, um aplicativo ou driver poderá chamar HidP_GetUsageValue para extrair os dados brutos de uso.

Para obter mais informações, consulte coleções HID.

Requisitos

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

Consulte também