função HidP_SetScaledUsageValue (hidpi.h)

Artigo
02/29/2024

A rotina HidP_SetScaledUsageValue converte um número físico com sinal e dimensionado em um valor lógico do uso de HID e define o valor de uso em um relatório HID especificado.

Sintaxe

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

Parâmetros

[in] ReportType

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

[in] UsagePage

Especifica a página de uso de um uso.

[in] LinkCollection

Especifica a coleção de links que contém o uso. Se LinkCollection for diferente de zero, a rotina definirá apenas o uso, se houver, nessa coleção de links. Se LinkCollection for zero, a rotina definirá o primeiro uso encontrado na coleção de nível superior associada a PreparsedData.

[in] Usage

Especifica o uso.

[in] UsageValue

Especifica o número físico assinado e dimensionado, que a rotina converte para o valor lógico do uso.

[in] PreparsedData

Ponteiro para os dados pré-preparados de um nível superior.

[in, out] 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 que HidP_GetCaps retorna na estrutura HIDP_CAPS de uma coleção.

Retornar valor

HidP_SetScaledUsageValue retorna um dos seguintes valores de status:

Código de retorno	Descrição
HIDP_STATUS_SUCCESS	A rotina definiu com êxito o valor de uso.
HIDP_STATUS_BAD_LOG_PHY_VALUES	O uso tem um intervalo lógico ou físico ilegal que impede o dimensionamento.
HIDP_STATUS_VALUE_OUT_OF_RANGE	O valor físico especificado está fora do intervalo e o uso não tem valor nulo.
HIDP_STATUS_INVALID_REPORT_LENGTH	O comprimento do relatório não é válido.
HIDP_STATUS_INVALID_REPORT_TYPE	O tipo de relatório especificado não é válido.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	O uso não existe no relatório especificado, mas existe em um relatório diferente do tipo especificado.
HIDP_STATUS_INVALID_PREPARSED_DATA	Os dados pré-preparados não são válidos.
HIDP_STATUS_USAGE_NOT_FOUND	O uso não existe em nenhum relatório do tipo de relatório especificado.
HIDP_STATUS_NULL	O valor físico especificado está fora do intervalo, o uso tem um valor nulo e a rotina define o valor nulo.

Comentários

HidP_SetScaledUsageValue define o bit de sinal.

Se a rotina retornar HIDP_STATUS_INCOMPATIBLE_REPORT_ID, o relatório especificado conterá o uso. No entanto, um aplicativo de modo de usuário ou driver de modo kernel pode definir o uso em um relatório inicializado em zero. Consulte Inicializando relatórios HID.

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