funzione HidP_UnsetUsages (hidpi.h)

Articolo
02/26/2024

Il HidP_UnsetUsages set di routine imposta l'utilizzo del pulsante di controllo HID specificato OFF (zero) in un report HID.

Sintassi

NTSTATUS HidP_UnsetUsages(
  [in]           HIDP_REPORT_TYPE     ReportType,
  [in]           USAGE                UsagePage,
  [in, optional] 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 di enumeratore HIDP_REPORT_TYPE che indica il tipo di report disponibile in Report.

[in] UsagePage

Specifica la pagina di utilizzo degli utilizzi specificati da UsageList.

[in, optional] LinkCollection

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

[in, out] UsageList

Puntatore alla matrice di utilizzi da impostare su OFF.

[in, out] UsageLength

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

[in] PreparsedData

Puntatore ai dati preparati della raccolta di primo livello associata al report disponibile in Report.

[in] Report

Puntatore a un report.

[in] ReportLength

Specifica le dimensioni, in byte, del report disponibile 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_UnsetUsages restituisce HIDP_STATUS_SUCCESS se viene impostato correttamente su OFF tutti gli usi in UsageList.

HidP_UnsetUsages restituisce uno dei valori di stato seguenti se uno dei parametri di input non è valido:

Codice restituito	Descrizione
HIDP_STATUS_INVALID_PREPARSED_DATA	I dati preparati specificati da PreparsedData non sono validi.
HIDP_STATUS_INVALID_REPORT_LENGTH	La lunghezza del report non è valida.
HIDP_STATUS_INVALID_REPORT_TYPE	Il tipo di report non è valido.
HIDP_STATUS_REPORT_DOES_NOT_EXIST	La raccolta non contiene un report del tipo specificato.

HidP_UnsetUsages restituisce uno dei valori di stato seguenti se non è stato possibile impostare su OFF uno degli usi in UsageList:

Codice restituito	Descrizione
HIDP_STATUS_BUTTON_NOT_PRESSED	Un utilizzo è già impostato su OFF.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Un utilizzo non è contenuto nel report specificato, ma è contenuto in un altro report del tipo specificato.
HIDP_STATUS_USAGE_NOT_FOUND	La routine non ha trovato un utilizzo in nessun report del tipo specificato.

Commenti

HidP_UnsetUsages imposta UsageLength come indicato di seguito:

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