funzione HidP_GetUsageValue (hidpi.h)

Articolo
08/07/2023

La routine HidP_GetUsageValue estrae i dati associati a un valore di controllo HID corrispondente ai criteri di selezione in un report HID.

Sintassi

NTSTATUS HidP_GetUsageValue(
  [in]  HIDP_REPORT_TYPE     ReportType,
  [in]  USAGE                UsagePage,
  [in]  USHORT               LinkCollection,
  [in]  USAGE                Usage,
  [out] PULONG               UsageValue,
  [in]  PHIDP_PREPARSED_DATA PreparsedData,
  [in]  PCHAR                Report,
  [in]  ULONG                ReportLength
);

Parametri

[in] ReportType

Specifica un valore dell'enumeratore HIDP_REPORT_TYPE che identifica il tipo di report.

[in] UsagePage

Specifica la pagina di utilizzo del valore.

[in] LinkCollection

Specifica la raccolta di collegamenti che contiene il valore. Se LinkCollection è diverso da zero, la routine cerca solo l'utilizzo in questa raccolta di collegamenti; in caso contrario, se LinkCollection è zero, la routine cerca l'utilizzo nella raccolta di livello superiore associata a PreparsedData.

[in] Usage

Specifica l'utilizzo del valore.

[out] UsageValue

Puntatore a un buffer in cui la routine restituisce i dati del valore.

[in] PreparsedData

Puntatore ai dati preparati di un insieme di livello superiore.

[in] Report

Puntatore a un report contenente valori.

[in] ReportLength

Specifica la lunghezza, in byte, del report disponibile in Report.

Valore restituito

HidP_GetUsageValue restituisce uno dei valori di stato seguenti:

Codice restituito	Descrizione
HIDP_STATUS_SUCCESS	La routine ha restituito correttamente i dati del valore.
HIDP_INVALID_REPORT_LENGTH	La lunghezza del report non è valida.
HIDP_INVALID_REPORT_TYPE	Il tipo di report specificato non è valido.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	La raccolta contiene un valore nella pagina di utilizzo specificata in un report del tipo specificato, ma non sono presenti tali usi nel report specificato.
HIDP_STATUS_INVALID_PREPARSED_DATA	I dati preparati non sono validi.
HIDP_STATUS_USAGE_NOT_FOUND	La raccolta non contiene un valore nella pagina di utilizzo specificata in qualsiasi report del tipo di report specificato.

Commenti

HidP_GetUsageValue non firma o ridimensiona il valore. Per estrarre un valore firmato, usare HidP_GetScaledUsageValue. Per assegnare manualmente il bit di segno, la posizione del bit di segno può essere determinata dalle informazioni nella struttura HIDP_VALUE_CAPS di un valore.

HidP_GetUsageValue è progettato per estrarre un valore di utilizzo per un utilizzo il cui numero di report è 1. Se l'utilizzo specificato ha un numero di report maggiore di 1, l'utilizzo fa parte di una matrice di valori di utilizzo. HidP_GetUsageValue restituisce solo il primo elemento di dati in una matrice di valori di utilizzo. Per estrarre tutti gli elementi di dati in una matrice di valori di utilizzo, usare HidP_GetUsageValueArray.

Per altre informazioni, vedere Raccolte HID.

Requisiti

Requisito	Valore
Client minimo supportato	Disponibile in Windows 2000 e versioni successive di Windows.
Piattaforma di destinazione	Universale
Intestazione	hidpi.h (include Hidpi.h)
Libreria	Hidparse.lib
IRQL	<= DISPATCH_LEVEL