HidOutputReport HidOutputReport HidOutputReport HidOutputReport Class

Definition

public : sealed class HidOutputReport : IHidOutputReportpublic sealed class HidOutputReport : IHidOutputReportPublic NotInheritable Class HidOutputReport Implements IHidOutputReport// You can use this class in JavaScript.

Attributes

ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute

Remarks

The following example demonstrates how a Windows Store app built with XAML and C# uses the CreateOutputReport method to create an output report. This example then uses the SendOutputReportAsync method to send the report to the device.

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

public : IBuffer Data { get; set; }public IBuffer Data { get; set; }Public ReadWrite Property Data As IBuffer// You can use this property in JavaScript.

public : ushort Id { get; }public ushort Id { get; }Public ReadOnly Property Id As ushort// You can use this property in JavaScript.

public : HidBooleanControl GetBooleanControl(unsigned short usagePage, unsigned short usageId)public HidBooleanControl GetBooleanControl(UInt16 usagePage, UInt16 usageId)Public Function GetBooleanControl(usagePage As UInt16, usageId As UInt16) As HidBooleanControl// You can use this method in JavaScript.

public : HidBooleanControl GetBooleanControlByDescription(HidBooleanControlDescription controlDescription)public HidBooleanControl GetBooleanControlByDescription(HidBooleanControlDescription controlDescription)Public Function GetBooleanControlByDescription(controlDescription As HidBooleanControlDescription) As HidBooleanControl// You can use this method in JavaScript.

public : HidNumericControl GetNumericControl(unsigned short usagePage, unsigned short usageId)public HidNumericControl GetNumericControl(UInt16 usagePage, UInt16 usageId)Public Function GetNumericControl(usagePage As UInt16, usageId As UInt16) As HidNumericControl// You can use this method in JavaScript.

public : HidNumericControl GetNumericControlByDescription(HidNumericControlDescription controlDescription)public HidNumericControl GetNumericControlByDescription(HidNumericControlDescription controlDescription)Public Function GetNumericControlByDescription(controlDescription As HidNumericControlDescription) As HidNumericControl// You can use this method in JavaScript.