HidInputReport Classe

Définition

Espace de noms:

Windows.Devices.HumanInterfaceDevice

Représente un rapport d’entrée HID.

Les appareils émettent des rapports d’entrée pour décrire les modifications d’état, l’entrée utilisateur et d’autres données spécifiques à l’appareil. Par exemple, un périphérique clavier HID utilise un rapport d’entrée pour signaler une pression sur la touche. Un capteur de présence HID utilise un rapport d’entrée pour signaler un événement de détection de présence.

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

Héritage

Object Platform::Object IInspectable HidInputReport

Attributs

ContractVersionAttribute MarshalingBehaviorAttribute

Configuration requise pour Windows

Famille d’appareils	Windows 10 (introduit dans 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract	Windows.Foundation.UniversalApiContract (introduit dans v1.0)

Remarques

L’exemple suivant montre comment une application UWP créée avec XAML et C# utilise la méthode GetInputReportAsync pour obtenir un rapport d’entrée.

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

Propriétés

ActivatedBooleanControls	Obtient les contrôles booléens actuellement activés pour l’appareil HID donné.
Data	Obtient les données associées à un rapport d’entrée donné.
Id	Obtient l’identificateur associé à un rapport d’entrée donné.
TransitionedBooleanControls	Obtient les contrôles booléens récemment transitionnés pour l’appareil HID donné.

Méthodes

GetBooleanControl(UInt16, UInt16)	Récupère le contrôle booléen associé aux paramètres usagePage et usageId et trouvé dans le rapport d’entrée donné.
GetBooleanControlByDescription(HidBooleanControlDescription)	Récupère le contrôle booléen décrit par le paramètre controlDescription et trouvé dans le rapport d’entrée donné.
GetNumericControl(UInt16, UInt16)	Récupère le contrôle numérique associé aux paramètres usagePage et usageId et trouvé dans le rapport d’entrée donné.
GetNumericControlByDescription(HidNumericControlDescription)	Récupère le contrôle numérique décrit par le paramètre controlDescription et trouvé dans le rapport d’entrée donné.

Voir aussi

• Exemple d’appareil HID personnalisé