Export (0) Print
Expand All
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

HidOutputReport class

Applies to Windows and Windows Phone

Represents an output report.

Hosts issue output reports to request changes on the device. For example, a host could issue a request to a keyboard to turn an LED on or off.

Syntax


var hidOutputReport = createOutputReport();
var hidOutputReport = createOutputReport(uInt16);

Attributes

[DualApiPartition()]
[MarshalingBehavior(Agile)]
[Version(0x06030000)]

Members

The HidOutputReport class has these types of members:

Methods

The HidOutputReport class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
GetBooleanControl Retrieves the boolean control associated with the given usagePage and usageId.
GetBooleanControlByDescription Retrieves the boolean control associated with the given controlDescription.
GetNumericControl Retrieves the numeric control associated with the given usagePage and usageId.
GetNumericControlByDescription Retrieves the numeric control associated with the given controlDescription.

 

Properties

The HidOutputReport class has these properties.

PropertyAccess typeDescription

Data

Read/writeRetrieves, or sets, the data associated with a given output report.

Id

Read-onlyRetrieves the identifier associated with a given output report.

 

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



Requirements

Minimum supported client

Windows 8.1 [Windows Store apps, desktop apps]

Minimum supported server

Windows Server 2012 R2 [Windows Store apps, desktop apps]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

Windows.Devices.HumanInterfaceDevice
Windows::Devices::HumanInterfaceDevice [C++]

Metadata

Windows.winmd

See also

Object

 

 

Show:
© 2014 Microsoft