HidP_SetUsageValueArray-Funktion (hidpi.h)

  • Artikel

Die HidP_SetUsageValueArray Routine legt ein Array für die Verwendung von HID-Steuerelementen in einem angegebenen HID-Bericht fest.

Syntax

NTSTATUS HidP_SetUsageValueArray(
  [in]      HIDP_REPORT_TYPE     ReportType,
  [in]      USAGE                UsagePage,
  [in]      USHORT               LinkCollection,
  [in]      USAGE                Usage,
  [in]      PCHAR                UsageValue,
  [in]      USHORT               UsageValueByteLength,
  [in]      PHIDP_PREPARSED_DATA PreparsedData,
  [in, out] PCHAR                Report,
  [in]      ULONG                ReportLength
);

Parameter

[in] ReportType

Gibt einen HIDP_REPORT_TYPE Enumeratorwert an, der den Typ des HID-Berichts angibt, der sich unter Bericht befindet.

[in] UsagePage

Gibt die Nutzungsseite einer Verwendung an.

[in] LinkCollection

Gibt die Linkauflistung an, die die Verwendung enthält. Wenn LinkCollection nichtzero ist, legt die Routine nur die Verwendung in dieser Linkauflistung fest, sofern vorhanden. Wenn LinkCollection null ist, legt die Routine die erste Verwendung fest, die sie in der Auflistung der obersten Ebene findet, die PreparsedData zugeordnet ist.

[in] Usage

Gibt die Verwendung an.

[in] UsageValue

Zeiger auf einen vom Aufrufer zugewiesenen Puffer, der die Daten enthält, die dem Verwendungswertarray zugeordnet sind.

[in] UsageValueByteLength

Gibt die Länge des UsageValue-Puffers in Bytes an.

[in] PreparsedData

Zeiger auf die vorbereiteten Daten einer obersten Ebene.

[in, out] Report

Zeiger auf einen HID-Bericht.

[in] ReportLength

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

Rückgabewert

HidP_SetUsageValueArray gibt einen der folgenden status Werte zurück:

Rückgabecode Beschreibung
HIDP_STATUS_SUCCESS
 Die Routine hat den Nutzungswert erfolgreich festgelegt.
HIDP_STATUS_INVALID_REPORT_LENGTH
 Die Berichtslänge ist ungültig.
HIDP_STATUS_INVALID_REPORT_TYPE
 Der angegebene Berichtstyp ist ungültig.
HIDP_STATUS_BUFFER_TOO_SMALL
 Die Größe des UsageValue-Puffers in Bytes ist zu klein.
HIDP_STATUS_INCOMPATIBLE_REPORT_ID
 Die Verwendung ist im angegebenen Bericht nicht vorhanden, aber in einem anderen Bericht des angegebenen Typs vorhanden.
HIDP_STATUS_NOT_VALUE_ARRAY
 Die angegebene Verwendung ist kein Verwendungswertarray.
HIDP_STATUS_INVALID_PREPARSED_DATA
 Die vorbereiteten Daten sind ungültig.
HIDP_STATUS_REPORT_DOES_NOT_EXIST
 Es gibt keine Berichte des angegebenen Typs.
HIDP_STATUS_NOT_IMPLEMENTED
 Die Berichtsgröße der Datenfelder, die für das Verwendungswertarray angegeben sind, ist kein Vielfaches von acht Bits.
HIDP_STATUS_USAGE_NOT_FOUND
 Die Verwendung ist in keinem Bericht des angegebenen Berichtstyps vorhanden.

Hinweise

Die erforderliche Größe des UsageValue-Puffers in Bytes wird bestimmt, indem die BitSize - und ReportCount-Member der HIDP_VALUE_CAPS Struktur des Verwendungswertarrays multipliziert und das Ergebnis auf das nächste Byte aufgerundet wird.

HidP_SetUsageValueArray unterstützt nur Verwendungswertarrays, bei denen jedes Datenfeld des Arrays ein Vielfaches von acht Bits ist.

Der Aufrufer muss den UsageValue-Puffer genau so festlegen, wie er im Bericht auftreten soll.

Weitere Informationen finden Sie unter HID-Sammlungen.

Anforderungen

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

Weitere Informationen

HidP_SetScaledUsageValue

HidP_SetUsageValue

_HIDP_PREPARSED_DATA