funzione HidP_SetUsages (hidpi.h)

Articolo
02/29/2024

La routine HidP_SetUsages imposta i pulsanti di controllo HID specificati ON (1) in un report HID.

Sintassi

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

Parametri

[in] ReportType

Specifica un valore enumeratore HIDP_REPORT_TYPE che indica il tipo di report disponibile in Report.

[in] UsagePage

Specifica la pagina di utilizzo per gli utilizzi specificati da UsageList.

[in] LinkCollection

Specifica la raccolta di collegamenti che contiene gli utilizzi. Se LinkCollection è diverso da zero, la routine imposta solo gli utilizzi, se presenti, in questa raccolta di collegamenti. Se LinkCollection è zero, la routine imposta il primo utilizzo per ogni utilizzo specificato nella raccolta di livello superiore associata a PreparsedData.

[in, out] UsageList

Puntatore alla matrice di utilizzi.

[in, out] UsageLength

Specifica, in base all'input, il numero di utilizzi in UsageList. Per informazioni sul valore di output, vedere la sezione Osservazioni.

[in] PreparsedData

Puntatore ai dati pronti della raccolta di livello superiore associata al report disponibile in Report.

[in] Report

Puntatore a un report.

[in] ReportLength

Specifica le dimensioni, in byte, del report che si trova in Report, che deve essere uguale alla lunghezza del report per il tipo di report specificato che HidP_GetCaps restituisce nella struttura HIDP_CAPS di una raccolta.

Valore restituito

HidP_SetUsages restituisce uno dei valori di stato seguenti:

Codice restituito	Descrizione
HIDP_STATUS_SUCCESS	La routine imposta correttamente il valore di utilizzo.
HIDP_STATUS_BUFFER_TOO_SMALL	Non è possibile impostare un utilizzo in una matrice di pulsanti perché la matrice è già completamente impostata.
HIDP_STATUS_INVALID_REPORT_LENGTH	La lunghezza del report non è valida.
HIDP_STATUS_INVALID_REPORT_TYPE	Il tipo di report specificato non è valido.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Un utilizzo non esiste nel report specificato, ma esiste in un report diverso del tipo specificato.
HIDP_STATUS_INVALID_PREPARSED_DATA	I dati pronti non sono validi.
HIDP_STATUS_USAGE_NOT_FOUND	Un utilizzo non esiste in alcun report del tipo di report specificato.

Commenti

Se HidP_SetUsages non può impostare un utilizzo in UsageList, la routine imposta UsageLength sull'indice dell'utilizzo che non è stato possibile impostare e restituisce un valore di stato che indica l'errore.

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