função HidP_GetSpecificValueCaps (hidpi.h)

Artigo
08/07/2023

A rotina HidP_GetSpecificValueCaps retorna uma matriz de capacidade de valor que descreve todos os valores de controle HID que atendem a um critério de seleção especificado.

Sintaxe

NTSTATUS HidP_GetSpecificValueCaps(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in]      USAGE                Usage,
  [out]     PHIDP_VALUE_CAPS     ValueCaps,
  [in, out] PUSHORT              ValueCapsLength,
  [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 for diferente de zero, somente os valores que especificam essa página de uso serão retornados.

[in] LinkCollection

Especifica uma coleção de links como critérios de pesquisa. Se LinkCollection for diferente de zero, somente os valores que fazem parte dessa coleção de links serão retornados.

[in] Usage

Especifica um uso de HID como critérios de pesquisa. Se Usage for diferente de zero, somente os valores que especificam esse uso serão retornados.

[out] ValueCaps

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

[in, out] ValueCapsLength

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

[in] PreparsedData

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

Retornar valor

HidP_GetSpecificValueCaps retorna um dos seguintes valores de status:

Código de retorno	Valor de status NT	Descrição
HIDP_STATUS_SUCCESS	0x00110000	A rotina retornou com êxito os dados de funcionalidade.
HIDP_STATUS_INVALID_PREPARSED_DATA	0xc0110001	Os dados pré-preparados não são válidos.
HIDP_STATUS_USAGE_NOT_FOUND	0xc0110004	O uso não existe em nenhum relatório do tipo de relatório especificado.

Comentários

O tamanho necessário do buffer ValueCaps é especificado pelos membros NumberXxxValueCaps da estrutura HIDP_CAPS de uma coleção de nível superior.

Ao chamar HidP_GetSpecificValueCaps, especificar zero para UsagePage, Usage e LinkCollection é equivalente a chamar HidP_GetValueCaps.

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