HidInputReport Klasse

Definition

Namespace:

Windows.Devices.HumanInterfaceDevice

Stellt einen HID-Eingabebericht dar.

Geräte geben Eingabeberichte aus, um Zustandsänderungen, Benutzereingaben und andere gerätespezifische Daten zu beschreiben. Beispielsweise würde ein HID-Tastaturgerät einen Eingabebericht verwenden, um einen Tastendruck zu signalisieren. Ein HID-Anwesenheitssensor verwendet einen Eingabebericht, um ein Anwesenheitserkennungsereignis zu signalisieren.

public ref class HidInputReport sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class HidInputReport final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class HidInputReport

Public NotInheritable Class HidInputReport

Vererbung

Object Platform::Object IInspectable HidInputReport

Attribute

ContractVersionAttribute MarshalingBehaviorAttribute

Windows-Anforderungen

Gerätefamilie	Windows 10 (eingeführt in 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (eingeführt in v1.0)

Hinweise

Im folgenden Beispiel wird veranschaulicht, wie eine mit XAML und C# erstellte UWP-App die GetInputReportAsync-Methode verwendet, um einen Eingabebericht abzurufen.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

using Windows.Devices.Enumeration;
using Windows.Devices.HumanInterfaceDevice;
using Windows.Storage;
using Windows.Storage.Streams;

namespace HidSampleCS
{
    class Vendor
    {
        private async void ReadWriteToHidDevice(HidDevice device)
        {
            if (device != null)
            {
                // construct a HID output report to send to the device
                HidOutputReport outReport = device.CreateOutputReport();

                /// Initialize the data buffer and fill it in
                byte[] buffer = new byte[] { 10, 20, 30, 40 };

                DataWriter dataWriter = new DataWriter();
                dataWriter.WriteBytes(buffer);

                outReport.Data = dataWriter.DetachBuffer();

                // Send the output report asynchronously
                await device.SendOutputReportAsync(outReport);

                //
                // Sent output report successfully 
                // Now lets try read an input report 
                //
                HidInputReport inReport = await device.GetInputReportAsync();

                if (inReport != null)
                {
                    UInt16 id = inReport.Id;
                    var bytes = new byte[4];
                    DataReader dataReader = DataReader.FromBuffer(inReport.Data);
                    dataReader.ReadBytes(bytes);
                }
                else
                {
                    this.NotifyUser("Invalid input report received");
                }
            }
            else
            {
                this.NotifyUser("device is NULL");
            }
        }
    }
}

Eigenschaften

ActivatedBooleanControls	Ruft die derzeit aktivierten booleschen Steuerelemente für das angegebene HID-Gerät ab.
Data	Ruft die Einem angegebenen Eingabebericht zugeordneten Daten ab.
Id	Ruft den Bezeichner ab, der einem bestimmten Eingabebericht zugeordnet ist.
TransitionedBooleanControls	Ruft die kürzlich übertragenen booleschen Steuerelemente für das angegebene HID-Gerät ab.

Methoden

GetBooleanControl(UInt16, UInt16)	Ruft das boolesche Steuerelement ab, das dem usagePage - und usageId-Parameter zugeordnet ist und im angegebenen Eingabebericht gefunden wurde.
GetBooleanControlByDescription(HidBooleanControlDescription)	Ruft das boolesche Steuerelement ab, das vom controlDescription-Parameter beschrieben und im angegebenen Eingabebericht gefunden wird.
GetNumericControl(UInt16, UInt16)	Ruft das numerische Steuerelement ab, das den Parametern usagePage und usageId zugeordnet ist und im angegebenen Eingabebericht gefunden wurde.
GetNumericControlByDescription(HidNumericControlDescription)	Ruft das numerische Steuerelement ab, das vom controlDescription-Parameter beschrieben und im angegebenen Eingabebericht gefunden wird.

Weitere Informationen

• Beispiel für ein benutzerdefiniertes HID-Gerät