função HidP_GetSpecificButtonCaps (hidpi.h)

Artigo
02/07/2025

A rotina de HidP_GetSpecificButtonCaps retorna uma matriz de funcionalidade de botão que descreve todos os botões de controle HID em uma coleção de de nível superior que atendam a um critério de seleção especificado.

Sintaxe

NTSTATUS HidP_GetSpecificButtonCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in]      USAGE                Usage,
  [out]     PHIDP_BUTTON_CAPS    ButtonCaps,
  [in, out] PUSHORT              ButtonCapsLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData
);

Parâmetros

[in] ReportType

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

[in] UsagePage

Especifica uma página de uso como critérios de pesquisa. Se UsagePage não for zero, somente os botões que especificam essa página de uso serão retornados.

[in] LinkCollection

Especifica uma coleção de links como um critério de pesquisa. Se LinkCollection não for zero, somente os botões que fazem parte dessa coleção de links serão retornados.

[in] Usage

Especifica um de uso de HID como critério de pesquisa. Se Uso não for zero, somente os botões que especificarem esse uso serão retornados.

[out] ButtonCaps

Ponteiro para um buffer alocado pelo chamador no qual a rotina retorna uma matriz de funcionalidade de botão para o tipo de relatório especificado.

[in, out] ButtonCapsLength

Especifica o comprimento na entrada, em elementos de matriz, do buffer fornecido em ButtonCaps. Na saída, esse parâmetro é definido como o número de elementos que a rotina realmente retornou.

[in] PreparsedData

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

Valor de retorno

HidP_GetSpecificButtonCaps retorna um dos seguintes valores de status:

Código de retorno	Descrição
HIDP_STATUS_SUCCESS	A rotina retornou com êxito os dados de funcionalidade.
HIDP_STATUS_INVALID_PREPARSED_DATA	Os dados pré-parados não são válidos.

Observações

O tamanho necessário da matriz ButtonCaps é especificado pelo NumberXxxButtonCaps membros da estrutura de HIDP_CAPS de uma coleção de nível superior.

Ao chamar HidP_GetSpecificButtonCaps, especificar zero para UsagePage, Usagee LinkCollection é equivalente a chamar HidP_GetButtonCaps.

Para obter mais informações sobre a funcionalidade de uma coleção, consulte Obtendo informações de coleção.

Consulte também 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	PASSIVE_LEVEL

Consulte também

Partilhar via