HidP_SetUsages-Funktion (hidpi.h)

Artikel
02/29/2024

Die HidP_SetUsages Routine legt die angegebenen HID-Steuerelementschaltflächen in einem HID-Bericht AUF (1) 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 Enumeratorwert an, der den Typ des Berichts angibt, der sich unter Bericht befindet.

[in] UsagePage

Gibt die Verwendungsseite für die von UsageList angegebenen Verwendungen an.

[in] LinkCollection

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

[in, out] UsageList

Zeiger auf das Array von Verwendungen.

[in, out] UsageLength

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

[in] PreparsedData

Zeiger auf die vorbereiteten Daten der Auflistung der obersten Ebene, die dem Bericht unter Bericht zugeordnet ist.

[in] Report

Zeiger auf einen Bericht.

[in] ReportLength

Gibt die Größe des Berichts in Byte an, der sich unter Bericht befindet, die der Berichtslänge für den angegebenen Berichtstyp entsprechen muss, der HidP_GetCaps in der HIDP_CAPS-Struktur einer Auflistung zurückgibt.

Rückgabewert

HidP_SetUsages gibt einen der folgenden status Werte zurück:

Rückgabecode	Beschreibung
HIDP_STATUS_SUCCESS	Die Routine hat den Nutzungswert 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	Im angegebenen Bericht ist keine Verwendung vorhanden, aber sie ist in einem anderen Bericht des angegebenen Typs vorhanden.
HIDP_STATUS_INVALID_PREPARSED_DATA	Die vorbereiteten Daten sind ungültig.
HIDP_STATUS_USAGE_NOT_FOUND	In keinem Bericht des angegebenen Berichtstyps ist eine Verwendung vorhanden.

Hinweise

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

Weitere Informationen finden Sie unter HID-Auflistungen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Verfügbar in Windows 2000 und höheren Versionen von Windows.
Zielplattform	Universell
Header	hidpi.h (hidpi.h einschließen)
Bibliothek	Hidparse.lib
IRQL	<= DISPATCH_LEVEL