HidDevice HidDevice HidDevice HidDevice Class

Gets the product identifier for the given HID device.

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

Remarks

Valid values are 0 through 0xFFFF.

Gets the usage identifier for the given HID device.

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

Gets the usage page of the top-level collection.

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

Remarks

The UsagePage of the top-level collection is retrieved from the HID report descriptor.

Gets the vendor identifier for the given HID device.

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

Remarks

Valid values are 0 through 0xFFFF.

Gets the version, or revision, number for the given HID device.

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

Remarks

The version is retrieved from the device descriptor.

Valid values are 0 through 0xFFFF.

Closes the connection between the host and the given HID device.

public : void Close()This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.

Creates the only, or default, feature report that the host will send to the device.

public : HidFeatureReport CreateFeatureReport()public HidFeatureReport CreateFeatureReport()Public Function CreateFeatureReport() As HidFeatureReport// You can use this method in JavaScript.

See Also

CreateFeatureReport(UInt16)CreateFeatureReport(UInt16)CreateFeatureReport(UInt16)CreateFeatureReport(UInt16)

Creates a feature report, identified by the reportId parameter, that the host will send to the device.

public : HidFeatureReport CreateFeatureReport(unsigned short reportId)public HidFeatureReport CreateFeatureReport(UInt16 reportId)Public Function CreateFeatureReport(reportId As UInt16) As HidFeatureReport// You can use this method in JavaScript.

See Also

CreateFeatureReport()CreateFeatureReport()CreateFeatureReport()CreateFeatureReport()

Creates the only, or default, output report that the host will send to the device.

public : HidOutputReport CreateOutputReport()public HidOutputReport CreateOutputReport()Public Function CreateOutputReport() As HidOutputReport// You can use this method in JavaScript.

See Also

CreateOutputReport(UInt16)CreateOutputReport(UInt16)CreateOutputReport(UInt16)CreateOutputReport(UInt16)

Creates an output report, identified by the reportId parameter, that the host will send to the device.

public : HidOutputReport CreateOutputReport(unsigned short reportId)public HidOutputReport CreateOutputReport(UInt16 reportId)Public Function CreateOutputReport(reportId As UInt16) As HidOutputReport// You can use this method in JavaScript.

See Also

CreateOutputReport()CreateOutputReport()CreateOutputReport()CreateOutputReport()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

This member is not implemented in C++void Dispose()Sub Disposevoid Dispose()

Opens a handle to the device identified by the deviceId parameter. The access type is specified by the accessMode parameter.

public : static IAsyncOperation<HidDevice> FromIdAsync(PlatForm::String deviceId, FileAccessMode accessMode)public static IAsyncOperation<HidDevice> FromIdAsync(String deviceId, FileAccessMode accessMode)Public Static Function FromIdAsync(deviceId As String, accessMode As FileAccessMode) As IAsyncOperation( Of HidDevice )// You can use this method in JavaScript.

Remarks

The first time this method is invoked by a store app, it should be called from a UI thread in order to display the consent prompt. After the user has granted consent, the method can be invoked from any application thread.

The manifest for your app must declare a specific HID device capability before you invoke this method; and, this capability must map to the capabilities of the target device.

If there is no declaration in the manifest, or, if the declaration specifies a device not supported by the HID API, this method fails with an error of E_ACCESSDENIED.

Retrieves the descriptions of the boolean controls for the given HID device.

public : IVectorView<HidBooleanControlDescription> GetBooleanControlDescriptions(HidReportType reportType, unsigned short usagePage, unsigned short usageId)public IReadOnlyList<HidBooleanControlDescription> GetBooleanControlDescriptions(HidReportType reportType, UInt16 usagePage, UInt16 usageId)Public Function GetBooleanControlDescriptions(reportType As HidReportType, usagePage As UInt16, usageId As UInt16) As IReadOnlyList( Of HidBooleanControlDescription )// You can use this method in JavaScript.

Remarks

Boolean controls are simple controls that return On/Off values. (They are sometimes referred to as button controls.)

Retrieves an Advanced Query Syntax (AQS) string based on the given usagePage and usageId.

public : static PlatForm::String GetDeviceSelector(unsigned short usagePage, unsigned short usageId)public static string GetDeviceSelector(UInt16 usagePage, UInt16 usageId)Public Static Function GetDeviceSelector(usagePage As UInt16, usageId As UInt16) As string// You can use this method in JavaScript.

See Also

GetDeviceSelector(UInt16, UInt16, UInt16, UInt16)GetDeviceSelector(UInt16, UInt16, UInt16, UInt16)GetDeviceSelector(UInt16, UInt16, UInt16, UInt16)GetDeviceSelector(UInt16, UInt16, UInt16, UInt16)

Retrieves an Advanced Query Syntax (AQS) string based on the given usagePage, usageId, vendorId, and productId.

public : static PlatForm::String GetDeviceSelector(unsigned short usagePage, unsigned short usageId, unsigned short vendorId, unsigned short productId)public static string GetDeviceSelector(UInt16 usagePage, UInt16 usageId, UInt16 vendorId, UInt16 productId)Public Static Function GetDeviceSelector(usagePage As UInt16, usageId As UInt16, vendorId As UInt16, productId As UInt16) As string// You can use this method in JavaScript.

See Also

GetDeviceSelector(UInt16, UInt16)GetDeviceSelector(UInt16, UInt16)GetDeviceSelector(UInt16, UInt16)GetDeviceSelector(UInt16, UInt16)

Asynchronously retrieves the first, or default, feature report from the given HID device.

public : IAsyncOperation<HidFeatureReport> GetFeatureReportAsync()public IAsyncOperation<HidFeatureReport> GetFeatureReportAsync()Public Function GetFeatureReportAsync() As IAsyncOperation( Of HidFeatureReport )// You can use this method in JavaScript.

Remarks

This instance of the method retrieves the first available feature report.

See Also

GetFeatureReportAsync(UInt16)GetFeatureReportAsync(UInt16)GetFeatureReportAsync(UInt16)GetFeatureReportAsync(UInt16)

Asynchronously retrieves a feature report, identified by the reportId parameter, for the given HID device.

public : IAsyncOperation<HidFeatureReport> GetFeatureReportAsync(unsigned short reportId)public IAsyncOperation<HidFeatureReport> GetFeatureReportAsync(UInt16 reportId)Public Function GetFeatureReportAsync(reportId As UInt16) As IAsyncOperation( Of HidFeatureReport )// You can use this method in JavaScript.

See Also

GetFeatureReportAsync()GetFeatureReportAsync()GetFeatureReportAsync()GetFeatureReportAsync()

Asynchronously retrieves the default, or first, input report from the given HID device.

public : IAsyncOperation<HidInputReport> GetInputReportAsync()public IAsyncOperation<HidInputReport> GetInputReportAsync()Public Function GetInputReportAsync() As IAsyncOperation( Of HidInputReport )// You can use this method in JavaScript.

Examples

Here, we retrieve an input report (inputReport) and get the content of the report in the handler for the InputReportReceived event, triggered when the asynchronous call completes.

HidInputReport inputReport = await device.GetInputReportAsync();
.
.
.
private void InputReportReceived(
    HidDevice sender, 
    HidInputReportReceivedEventArgs args)
    {
        HidInputReport inputReport = args.Report;
        IBuffer buffer = inputReport.Data;
        DataReader dr = DataReader.FromBuffer(buffer);
        byte[] bytes = new byte[inputReport.Data.Length];
        dr.ReadBytes(bytes);

        String inputReportContent = 
           System.Text.Encoding.ASCII.GetString(bytes);
    }

Remarks

When this method completes, the InputReportReceived event is triggered.

To access the content of the input report, you must set up a listener for the InputReportReceived event and get the Report property of HidInputReportReceivedEventArgs object in the event handler.

See Also

GetInputReportAsync(UInt16)GetInputReportAsync(UInt16)GetInputReportAsync(UInt16)GetInputReportAsync(UInt16)

Asynchronously retrieves an input report, identified by the reportId parameter, from the given HID device.

public : IAsyncOperation<HidInputReport> GetInputReportAsync(unsigned short reportId)public IAsyncOperation<HidInputReport> GetInputReportAsync(UInt16 reportId)Public Function GetInputReportAsync(reportId As UInt16) As IAsyncOperation( Of HidInputReport )// You can use this method in JavaScript.

Examples

Here, we retrieve an input report (inputReport) and get the content of the report in the handler for the InputReportReceived event, triggered when the asynchronous call completes.

HidInputReport inputReport = await device.GetInputReportAsync();
.
.
.
private void InputReportReceived(
    HidDevice sender, 
    HidInputReportReceivedEventArgs args)
    {
        HidInputReport inputReport = args.Report;
        IBuffer buffer = inputReport.Data;
        DataReader dr = DataReader.FromBuffer(buffer);
        byte[] bytes = new byte[inputReport.Data.Length];
        dr.ReadBytes(bytes);

        String inputReportContent = 
           System.Text.Encoding.ASCII.GetString(bytes);
    }

Remarks

When this method completes, the InputReportReceived event is triggered.

To access the content of the input report, you must set up a listener for the InputReportReceived event and get the Report property of HidInputReportReceivedEventArgs object in the event handler.

See Also

GetInputReportAsync()GetInputReportAsync()GetInputReportAsync()GetInputReportAsync()

Retrieves the descriptions of the numeric controls for the given HID device.

public : IVectorView<HidNumericControlDescription> GetNumericControlDescriptions(HidReportType reportType, unsigned short usagePage, unsigned short usageId)public IReadOnlyList<HidNumericControlDescription> GetNumericControlDescriptions(HidReportType reportType, UInt16 usagePage, UInt16 usageId)Public Function GetNumericControlDescriptions(reportType As HidReportType, usagePage As UInt16, usageId As UInt16) As IReadOnlyList( Of HidNumericControlDescription )// You can use this method in JavaScript.

Sends an feature report asynchronously from the host to the device.

public : IAsyncOperation<unsigned int> SendFeatureReportAsync(HidFeatureReport featureReport)public IAsyncOperation<uint> SendFeatureReportAsync(HidFeatureReport featureReport)Public Function SendFeatureReportAsync(featureReport As HidFeatureReport) As IAsyncOperation( Of uint )// You can use this method in JavaScript.

Sends an output report asynchronously from the host to the device.

public : IAsyncOperation<unsigned int> SendOutputReportAsync(HidOutputReport outputReport)public IAsyncOperation<uint> SendOutputReportAsync(HidOutputReport outputReport)Public Function SendOutputReportAsync(outputReport As HidOutputReport) As IAsyncOperation( Of uint )// You can use this method in JavaScript.

Establishes an event listener to handle input reports issued by the device when either GetInputReportAsync() or GetInputReportAsync(System.UInt16 reportId) is called.

public : event TypedEventHandler InputReportReceived<HidDevice,  HidInputReportReceivedEventArgs>public event TypedEventHandler InputReportReceived<HidDevice,  HidInputReportReceivedEventArgs>Public Event InputReportReceived<HidDevice,  HidInputReportReceivedEventArgs>// You can use this event in JavaScript.

Examples

Here, we retrieve an input report (inputReport) and get the content of the report in the handler for the InputReportReceived event, triggered when the asynchronous call completes.

HidInputReport inputReport = await device.GetInputReportAsync();
.
.
.
private void InputReportReceived(
    HidDevice sender, 
    HidInputReportReceivedEventArgs args)
    {
        HidInputReport inputReport = args.Report;
        IBuffer buffer = inputReport.Data;
        DataReader dr = DataReader.FromBuffer(buffer);
        byte[] bytes = new byte[inputReport.Data.Length];
        dr.ReadBytes(bytes);

        String inputReportContent = 
           System.Text.Encoding.ASCII.GetString(bytes);
    }

Remarks

This method waits for the device to interrupt the host when it has data to send. Internally, the HID WinRT API sends a IOCTL read request to a lower driver in the stack.

The IOCTL is translated by the HID minidriver into a protocol-specific request. For a USB device, the minidriver translates this into an INTERRUPT IN request. And, for an I2C device that is running over the Microsoft HID-I2C miniport driver, the minidriver will wait for the device to assert an interrupt.