Compartilhar via

função HidP_GetButtonCaps (hidpi.h)

  • Artigo

A rotina HidP_GetButtonCaps retorna uma matriz de recursos de botão que descreve todos os botões de controle HID em uma coleção de nível superior para um tipo especificado de relatório HID.

Sintaxe

NTSTATUS HidP_GetButtonCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [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.

[out] ButtonCaps

Ponteiro para um buffer alocado pelo chamador que a rotina usa para retornar uma matriz de recursos 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 real de elementos que a rotina retorna.

[in] PreparsedData

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

Retornar valor

HidP_GetButtonCaps 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.

Comentários

HidP_GetButtonCaps retorna a capacidade de todos os botões em uma coleção de nível superior para um tipo de relatório especificado.

ButtonCapsLength deve ser definido como o valor do membro NumberXxxButtonCaps da estrutura HIDP_CAPS retornada por HidP_GetCaps, em que Xxx especifica o tipo de relatório.

Para obter um subconjunto de recursos de botão, selecionado por uso, página de uso ou coleção de links, use HidP_GetSpecificButtonCaps.

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
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 PASSIVE_LEVEL

Confira também

HIDP_BUTTON_CAPS

HidP_GetCaps

HidP_GetSpecificButtonCaps

_HIDP_PREPARSED_DATA