função HidP_SetUsages (hidpi.h)

Artigo
02/29/2024

O HidP_SetUsages rotina define os botões de controle HID especificados ON (1) em um relatório HID.

Sintaxe

NTSTATUS HidP_SetUsages(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in, out] PUSAGE               UsageList,
  [in, out] PULONG               UsageLength,
  [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 localizado em Relatório.

[in] UsagePage

Especifica a página de uso para os usos especificados por UsageList.

[in] LinkCollection

Especifica a coleção de link que contém os usos. Se LinkCollection não for zero, a rotina definirá apenas os usos, se existirem, nesta coleção de links. Se LinkCollection for zero, a rotina definirá o primeiro uso para cada uso especificado na coleção de nível superior associada a PreparsedData.

[in, out] UsageList

Ponteiro para a matriz de usos.

[in, out] UsageLength

Especifica, na entrada, o número de usos em UsageList. Consulte a seção Comentários para obter informações sobre o valor de saída.

[in] PreparsedData

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

[in] Report

Ponteiro para um relatório.

[in] ReportLength

Especifica o tamanho, em bytes, do relatório 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_SetUsages 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_BUFFER_TOO_SMALL	Um uso em uma matriz de botões não pode ser definido porque a matriz já está totalmente definida.
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	Um uso não existe no relatório especificado, mas ele existe em um relatório diferente do tipo especificado.
HIDP_STATUS_INVALID_PREPARSED_DATA	Os dados pré-parados não são válidos.
HIDP_STATUS_USAGE_NOT_FOUND	Um uso não existe em nenhum relatório do tipo de relatório especificado.

Comentários

Se HidP_SetUsages não puder definir um uso em UsageList, a rotina definirá UsageLength como o índice do uso que não pôde ser definido e retornará um valor status que indica o erro.

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