função HidP_GetScaledUsageValue (hidpi.h)

  • Artigo

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 HIDP_REPORT_TYPE enumerador que identifica o tipo de relatório HID que contém o valor de uso 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 os dados pré-preparados da coleção 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 Relatório.

Retornar valor

HidP_GetScaledUsageValue retorna um dos seguintes valores de status:

Código de retorno Descrição
HIDP_STATUS_SUCCESS
 A rotina retornou com êxito o valor.
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 inválido. 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.

Comentários

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

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

Se a rotina retornar 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
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_GetUsageValue

HidP_GetUsageValueArray

_HIDP_PREPARSED_DATA