HidP_SetUsages-Funktion (hidpi.h)

Artikel
02/07/2025

Die HidP_SetUsages Routine legt die angegebenen HID-Steuerelementschaltflächen EIN (1) in einem HID-Bericht fest.

Syntax

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
);

Parameter

[in] ReportType

Gibt einen HIDP_REPORT_TYPE Enumerationswert an, der den Typ des Berichts angibt, der sich in Reportbefindet.

[in] UsagePage

Gibt die Verwendungsseite für die von UsageListangegebenen Verwendungsseiten an.

[in] LinkCollection

Gibt die Linkauflistung an, die die Verwendungen enthält. Wenn LinkCollection- ungleich Null ist, legt die Routine nur die Verwendungen fest, sofern vorhanden, in dieser Linkauflistung. Wenn LinkCollection- null ist, legt die Routine die erste Verwendung für jede angegebene Verwendung in der Auflistung der obersten Ebene, die PreparsedData-zugeordnet ist.

[in, out] UsageList

Zeigen Sie auf das Array der Verwendungen.

[in, out] UsageLength

Gibt bei Eingabe die Anzahl der Verwendungen in UsageListan. Informationen zum Ausgabewert finden Sie im Abschnitt "Hinweise".

[in] PreparsedData

Zeigen Sie auf die vordefinierten Daten der Auflistung der obersten Ebene, die dem Bericht zugeordnet ist, Report.

[in] Report

Zeiger auf einen Bericht.

[in] ReportLength

Gibt die Größe des Berichts in Bytes an, der sich in Reportbefindet, der der Berichtslänge für den angegebenen Berichtstyp entspricht, der in der HIDP_CAPS-Struktur einer Auflistung zurückgegeben HidP_GetCaps.

Rückgabewert

HidP_SetUsages gibt einen der folgenden Statuswerte zurück:

Rückgabecode	Beschreibung
HIDP_STATUS_SUCCESS	Die Routine hat den Verwendungswert erfolgreich festgelegt.
HIDP_STATUS_BUFFER_TOO_SMALL	Eine Verwendung in einem Schaltflächenarray kann nicht festgelegt werden, da das Array bereits vollständig festgelegt ist.
HIDP_STATUS_INVALID_REPORT_LENGTH	Die Berichtslänge ist ungültig.
HIDP_STATUS_INVALID_REPORT_TYPE	Der angegebene Berichtstyp ist ungültig.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID	Eine Verwendung ist im angegebenen Bericht nicht vorhanden, ist aber in einem anderen Bericht des angegebenen Typs vorhanden.
HIDP_STATUS_INVALID_PREPARSED_DATA	Die analysierten Daten sind ungültig.
HIDP_STATUS_USAGE_NOT_FOUND	Eine Verwendung ist in keinem Bericht des angegebenen Berichtstyps vorhanden.

Bemerkungen

Wenn HidP_SetUsages keine Verwendung in UsageList-festlegen kann, legt die Routine UsageLength- auf den Index der Verwendung fest, die nicht festgelegt werden konnte, und gibt einen Statuswert zurück, der den Fehler angibt.

Weitere Informationen finden Sie unter HID Collections.

Anforderungen

Anforderung	Wert
mindestens unterstützte Client-	Verfügbar in Windows 2000 und höheren Versionen von Windows.
Zielplattform-	Universal
Header-	hidpi.h (include Hidpi.h)
Library	Hidparse.lib
IRQL-	<= DISPATCH_LEVEL