função HidP_GetSpecificButtonCaps (hidpi.h)

A rotina HidP_GetSpecificButtonCaps 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 que atende 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 link como critérios de pesquisa. Se LinkCollection não for zero, somente os botões que fazem parte dessa coleção de link serão retornados.

[in] Usage

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

[out] ButtonCaps

Ponteiro para um buffer alocado pelo chamador no qual a rotina retorna 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 de elementos que a rotina realmente retornou.

[in] PreparsedData

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

Retornar valor

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.

Comentários

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

Ao chamar HidP_GetSpecificButtonCaps, especificar zero para UsagePage, Usage e 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
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_GetButtonCaps

HidP_GetCaps

_HIDP_PREPARSED_DATA