funzione HidP_GetUsages (hidpi.h)

Articolo
02/26/2024

La routine HidP_GetUsages restituisce un elenco di tutti gli utilizzi dei pulsanti di controllo HID presenti in una pagina di utilizzo specificata e che sono impostati su ON in un report HID.

Sintassi

NTSTATUS HidP_GetUsages(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [out]     PUSAGE               UsageList,
  [in, out] PULONG               UsageLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [out]     PCHAR                Report,
  [in]      ULONG                ReportLength
);

Parametri

[in] ReportType

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

[in] UsagePage

Specifica la pagina di utilizzo degli utilizzi del pulsante. La routine restituisce solo informazioni sui pulsanti in questa pagina di utilizzo.

[in] LinkCollection

Specifica la raccolta di collegamenti degli utilizzi del pulsante. Se LinkCollection è diverso da zero, la routine restituisce solo informazioni sui pulsanti contenuti nella raccolta di collegamenti; in caso contrario, se LinkCollection è zero, la routine restituisce informazioni su tutti i pulsanti nella raccolta di livello superiore associata a PreparsedData.

[out] UsageList

Puntatore a un buffer allocato dal chiamante utilizzato dalla routine per restituire gli utilizzi di tutti i pulsanti impostati su ON e appartengono alla pagina di utilizzo specificata da UsagePage.

[in, out] UsageLength

Specifica, in base all'input, la lunghezza, negli elementi della matrice, del buffer UsageList . Specifica, nell'output, il numero di pulsanti impostati su ON nella pagina di utilizzo specificata.

[in] PreparsedData

Puntatore ai dati pronti di una raccolta di primo livello.

[out] Report

Puntatore a un report.

[in] ReportLength

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

Valore restituito

HidP_GetUsages restituisce uno dei valori di stato seguenti:

Codice restituito	Descrizione
HIDP_STATUS_SUCCESS	La routine ha restituito tutti gli utilizzi dei pulsanti impostati su ON.
HIDP_INVALID_REPORT_LENGTH	La lunghezza del report non è valida.
HIDP_INVALID_REPORT_TYPE	Il tipo di report specificato non è valido.
HIDP_STATUS_BUFFER_TOO_SMALL	Il buffer UsageList è troppo piccolo per contenere tutti gli utilizzi attualmente impostati su ON nella pagina di utilizzo specificata.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	L'insieme contiene pulsanti nella pagina di utilizzo specificata in un report del tipo specificato, ma non esistono tali utilizzi nel report specificato.
HIDP_STATUS_INVALID_PREPARSED_DATA	I dati pronti non sono validi.
HIDP_STATUS_USAGE_NOT_FOUND	La raccolta non contiene pulsanti nella pagina di utilizzo specificata in alcun report del tipo di report specificato.

Commenti

Le applicazioni in modalità utente e i driver in modalità kernel chiamano HidP_MaxUsageListLength per determinare il numero massimo di pulsanti che possono essere restituiti per il tipo di report specificato. In alternativa, le applicazioni o i driver possono chiamare HidP_GetUsages e impostare (*UsageLength) su zero per restituire la lunghezza richiesta in UsageLength. In altre parole, UsageLength deve essere un puntatore valido che punta a un valore ULONG 0 per ottenere la lunghezza richiesta.

Le applicazioni o i driver determinano la lunghezza del report richiesta dai membri Xxx ReportByteLength nella struttura HIDP_CAPS di una raccolta di livello superiore.

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