HidSharp

https://docs.zer7.com/hidsharp/
Admin
HidSharp is a .NET library for communicating with HID (Human Interface Device) and serial devices...
Tokens:169,011
Snippets:1,000
Trust Score:7.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get Feature Setup Request (F#)

Source: https://docs.zer7.com/hidsharp/html/8301b95f-b727-e7d1-9655-30805a542236

Sends a Get Feature setup request using F#. The buffer parameter is used to store the retrieved feature report, with the first byte intended for the Report ID.

```F#
member GetFeature :
        buffer : byte[] -> unit
```

--------------------------------

### Get Feature Setup Request (C#)

Source: https://docs.zer7.com/hidsharp/html/8301b95f-b727-e7d1-9655-30805a542236

Sends a Get Feature setup request using C#. The buffer parameter is used to store the retrieved feature report, with the first byte intended for the Report ID.

```C#
public void GetFeature(
	byte[] buffer
)
```

--------------------------------

### Get Feature Setup Request (C++)

Source: https://docs.zer7.com/hidsharp/html/8301b95f-b727-e7d1-9655-30805a542236

Sends a Get Feature setup request using C++. The buffer parameter is used to store the retrieved feature report, with the first byte intended for the Report ID.

```C++
public:
void GetFeature(
	array<unsigned char>^ buffer
)
```

--------------------------------

### Get Feature Setup Request (VB)

Source: https://docs.zer7.com/hidsharp/html/8301b95f-b727-e7d1-9655-30805a542236

Sends a Get Feature setup request using Visual Basic. The buffer parameter is used to store the retrieved feature report, with the first byte intended for the Report ID.

```VB
Public Sub GetFeature (
	buffer As Byte()
)
```

--------------------------------

### HidDeviceInputReceiver Started Event

Source: https://docs.zer7.com/hidsharp/html/95a5ea0c-61ed-387a-c9c2-b8dbaa004040

Demonstrates the 'Started' event for the HidDeviceInputReceiver class. This event is typically used to signal the start of an input receiving process. It is available in C#, VB, C++, and F#.

```C#
public event EventHandler Started
```

```VB
Public Event Started As EventHandler
```

```C++
public:
 event EventHandler^ Started {
	void add (EventHandler^ value);
	void remove (EventHandler^ value);
}
```

```F#
member Started : IEvent<EventHandler,
    EventArgs>
```

--------------------------------

### HidSharp HidDeviceInputReceiver Methods

Source: https://docs.zer7.com/hidsharp/index

Provides methods for managing the reception of HID reports from a device. `Start` begins the listening process, while `TryRead` attempts to read incoming data.

```C#
Start Method 
TryRead Method
```

--------------------------------

### Open and Communicate with a HID Device using HidSharp

Source: https://docs.zer7.com/hidsharp/html/dd6edb84-59a0-b6aa-3568-257e4613a66a

This example shows how to open a specific HidDevice to obtain a HidStream for communication. It covers the process of selecting a device and establishing a connection for sending and receiving data.

```C#
using HidSharp;

// Assuming 'device' is a HidDevice object obtained from DeviceList.Local

if (device != null)
{
    try
    {
        HidStream hidStream = device.OpenStream();
        // Use hidStream for reading and writing data
        Console.WriteLine("Successfully opened HidStream.");
        // ... perform read/write operations ...
        hidStream.Dispose();
    }
    catch (DeviceException ex)
    {
        Console.WriteLine($"Error opening device: {ex.Message}");
    }
}
```

--------------------------------

### HidSharp.Device.Open Method

Source: https://docs.zer7.com/hidsharp/html/bd8ba910-3c87-f7bf-92c0-83ef1510ce49

Establishes a connection to the HID device. If the connection cannot be made, an exception is thrown. Overloads allow for specifying open configurations.

```C#
public DeviceStream Open()
public DeviceStream Open(OpenConfiguration configuration)
```

--------------------------------

### Start Method for HidDeviceInputReceiver

Source: https://docs.zer7.com/hidsharp/html/6ff3a17f-a905-1691-5670-2e7dec46117d

Initiates the input receiver for a HID device. This method takes a HidStream as input and begins processing HID reports until the stream is closed or the device is disconnected. It is essential to subsequently call TryRead to obtain the incoming reports.

```C#
public void Start(
	HidStream stream
)
```

```VB
Public Sub Start (
	stream As HidStream
)
```

```C++
public:
void Start(
	HidStream^ stream
)
```

```F#
member Start :
        stream : HidStream -> unit
```

--------------------------------

### Get Linux GUID in C#

Source: https://docs.zer7.com/hidsharp/html/a3298b42-0494-b9a8-dfd8-988992b5a2d3

Retrieves the GUID representing the Linux operating system using the HidSharp library.

```C#
public static Guid Linux { get; }
```

--------------------------------

### TryOpen Methods for HidDevice Connection

Source: https://docs.zer7.com/hidsharp/html/2190fe3c-def0-d816-9482-b2668f89c263

This snippet covers the different ways to attempt opening a connection to a HID device using the HidDevice class. It includes overloads that accept various stream types and configurations, inherited from the base Device class.

```C#
public bool TryOpen(DeviceStream deviceStream)
public bool TryOpen(HidStream hidStream)
public bool TryOpen(OpenConfiguration openConfiguration, DeviceStream deviceStream)
public bool TryOpen(OpenConfiguration openConfiguration, HidStream hidStream)
```

--------------------------------

### Open HidDevice

Source: https://docs.zer7.com/hidsharp/index

Provides methods to open a HidDevice, with overloads for different configurations and streams. This allows for establishing a connection to a HID device.

```C#
public HidStream Open (OpenConfiguration configuration, HidStream stream)
public HidStream Open (OpenConfiguration configuration)
public HidStream Open ()
```

--------------------------------

### Get Linux GUID in F#

Source: https://docs.zer7.com/hidsharp/html/a3298b42-0494-b9a8-dfd8-988992b5a2d3

Retrieves the GUID representing the Linux operating system using the HidSharp library in F#.

```F#
static member Linux : Guid with get
```

--------------------------------

### Create OpenOption from GUID (C++)

Source: https://docs.zer7.com/hidsharp/html/685592e7-b4fa-a406-1561-f9d02a0293bd

This C++ code snippet illustrates how to use the FromGuid method to create an OpenOption object from a System.Guid.

```C++
public:
static OpenOption^ FromGuid(
	Guid guid
)
```

--------------------------------

### Get Linux GUID in C++

Source: https://docs.zer7.com/hidsharp/html/a3298b42-0494-b9a8-dfd8-988992b5a2d3

Retrieves the GUID representing the Linux operating system using the HidSharp library in C++.

```C++
public:
static property Guid Linux {
	Guid get ();
}
```

--------------------------------

### Get Linux GUID in VB

Source: https://docs.zer7.com/hidsharp/html/a3298b42-0494-b9a8-dfd8-988992b5a2d3

Retrieves the GUID representing the Linux operating system using the HidSharp library in Visual Basic.

```VB
Public Shared ReadOnly Property Linux As Guid
	Get
```

--------------------------------

### Create OpenOption Instance (C#)

Source: https://docs.zer7.com/hidsharp/html/74a05b3d-96c3-9a7c-277e-b2c4c7da7f0d

Creates a new instance of OpenOption using the provided GUID, deserialization callback, serialization callback, and optional default value and friendly name.

```C#
public static OpenOption New(
	Guid guid,
	OpenOptionDeserializeCallback deserializeCallback,
	OpenOptionSerializeCallback serializeCallback,
	Object defaultValue = null,
	string friendlyName = null
)
```

```VB
Public Shared Function New (
	guid As Guid,
	deserializeCallback As OpenOptionDeserializeCallback,
	serializeCallback As OpenOptionSerializeCallback,
	Optional defaultValue As Object = Nothing,
	Optional friendlyName As String = Nothing
) As OpenOption
```

```C++
public:
static OpenOption^ New(
	Guid guid, 
	OpenOptionDeserializeCallback^ deserializeCallback, 
	OpenOptionSerializeCallback^ serializeCallback, 
	Object^ defaultValue = nullptr, 
	String^ friendlyName = nullptr
)
```

```F#
static member New :
        guid : Guid *
        deserializeCallback : OpenOptionDeserializeCallback *
        serializeCallback : OpenOptionSerializeCallback *
        ?defaultValue : Object *
        ?friendlyName : string
(* Defaults:
        let _defaultValue = defaultArg defaultValue null
        let _friendlyName = defaultArg friendlyName null
*) -> OpenOption
```

--------------------------------

### Get MacOS Guid in F#

Source: https://docs.zer7.com/hidsharp/html/8dfc44bf-f88d-f483-735c-4fc3aef053e0

Retrieves the Guid representing macOS devices using the MacOS property in F#.

```F#
static member MacOS : Guid with get
```

--------------------------------

### Try Open HID Device with Configuration

Source: https://docs.zer7.com/hidsharp/html/8048f117-2419-b61a-43f2-bce2a0c10838

Attempts to establish a connection to the HID device using the specified open configuration.

```C#
bool TryOpen(OpenConfiguration configuration, out HidStream stream);
```

--------------------------------

### TryOpen Method Signature in C#

Source: https://docs.zer7.com/hidsharp/html/ba411697-db18-8b7c-423d-f76350c38c41

This C# signature for the TryOpen method shows how to attempt opening a HID device. It takes an OpenConfiguration and outputs a DeviceStream and an Exception.

```csharp
public bool TryOpen(
	OpenConfiguration openConfig,
	out DeviceStream stream,
	out Exception exception
)
```

--------------------------------

### Get MacOS Guid in C++

Source: https://docs.zer7.com/hidsharp/html/8dfc44bf-f88d-f483-735c-4fc3aef053e0

Retrieves the Guid representing macOS devices using the MacOS property in C++.

```C++
public:
static property Guid MacOS {
	Guid get ();
}
```

--------------------------------

### Get MacOS Guid in C#

Source: https://docs.zer7.com/hidsharp/html/8dfc44bf-f88d-f483-735c-4fc3aef053e0

Retrieves the Guid representing macOS devices using the MacOS property in C#.

```C#
public static Guid MacOS { get; }
```

--------------------------------

### Try Open HID Device

Source: https://docs.zer7.com/hidsharp/html/8048f117-2419-b61a-43f2-bce2a0c10838

Attempts to establish a connection to the HID device.

```C#
bool TryOpen(out HidStream stream);
```

--------------------------------

### Get MacOS Guid in VB

Source: https://docs.zer7.com/hidsharp/html/8dfc44bf-f88d-f483-735c-4fc3aef053e0

Retrieves the Guid representing macOS devices using the MacOS property in Visual Basic.

```VB
Public Shared ReadOnly Property MacOS As Guid
	Get
```

--------------------------------

### Open HID Device Connection (F#)

Source: https://docs.zer7.com/hidsharp/html/e47a3f3e-3da6-7738-d276-0c1a87792e44

Establishes a connection to the HID device using F#. Returns a DeviceStream for communication. Ensure the HidSharp assembly is referenced.

```fsharp
member Open : unit -> DeviceStream
```

--------------------------------

### HidSharp.Device.TryOpen Method

Source: https://docs.zer7.com/hidsharp/html/bd8ba910-3c87-f7bf-92c0-83ef1510ce49

Attempts to establish a connection to the HID device without throwing an exception. Returns a boolean indicating success and outputs the DeviceStream if successful. Overloads allow for specifying open configurations.

```C#
public bool TryOpen(out DeviceStream stream)
public bool TryOpen(OpenConfiguration configuration, out DeviceStream stream)
```

--------------------------------

### AreDriversBeingInstalled Property - F#

Source: https://docs.zer7.com/hidsharp/html/634061b3-5669-f7f5-3fb6-713ec8ca7d58

Gets a boolean value indicating if drivers are currently being installed. This is an abstract property.

```F#
abstract AreDriversBeingInstalled : bool with get
```

--------------------------------

### AreDriversBeingInstalled Property - C#

Source: https://docs.zer7.com/hidsharp/html/634061b3-5669-f7f5-3fb6-713ec8ca7d58

Gets a boolean value indicating if drivers are currently being installed. This is an abstract property.

```C#
public abstract bool AreDriversBeingInstalled { get; }
```

--------------------------------

### Open HID Device Connection (C++)

Source: https://docs.zer7.com/hidsharp/html/e47a3f3e-3da6-7738-d276-0c1a87792e44

Establishes a connection to the HID device using C++. Returns a DeviceStream for communication. Ensure the HidSharp assembly is referenced.

```cpp
public:
DeviceStream^ Open()
```

--------------------------------

### AreDriversBeingInstalled Property (C#)

Source: https://docs.zer7.com/hidsharp/html/3096cc52-ee8a-529e-050b-be6d48691872

Gets a boolean value indicating if drivers are currently being installed. This is a read-only property.

```C#
public override bool AreDriversBeingInstalled { get; }
```

--------------------------------

### Create OpenOption from GUID (C#)

Source: https://docs.zer7.com/hidsharp/html/685592e7-b4fa-a406-1561-f9d02a0293bd

This C# code snippet demonstrates how to use the FromGuid method to create an OpenOption object from a System.Guid.

```C#
public static OpenOption FromGuid(
	Guid guid
)
```

--------------------------------

### OpenConfiguration Constructor

Source: https://docs.zer7.com/hidsharp/html/c2ee1239-fafc-46d1-826c-bf7984a38b2a

Initializes a new instance of the OpenConfiguration class. This is a parameterless constructor.

```C#
public OpenConfiguration()
```

```VB
Public Sub New
```

```C++
public:
OpenConfiguration()
```

```F#
new : unit -> OpenConfiguration
```

--------------------------------

### AreDriversBeingInstalled Property - C++

Source: https://docs.zer7.com/hidsharp/html/634061b3-5669-f7f5-3fb6-713ec8ca7d58

Gets a boolean value indicating if drivers are currently being installed. This is a public, virtual, abstract property.

```C++
public:
	virtual property bool AreDriversBeingInstalled {
		bool get () abstract;
	}
```

--------------------------------

### Create OpenOption from GUID (F#)

Source: https://docs.zer7.com/hidsharp/html/685592e7-b4fa-a406-1561-f9d02a0293bd

This F# code snippet explains how to use the FromGuid method to create an OpenOption object from a System.Guid.

```F#
static member FromGuid :
        guid : Guid -> OpenOption
```

--------------------------------

### AreDriversBeingInstalled Property - VB.NET

Source: https://docs.zer7.com/hidsharp/html/634061b3-5669-f7f5-3fb6-713ec8ca7d58

Gets a boolean value indicating if drivers are currently being installed. This is a public, must-override, read-only property.

```VB.NET
Public MustOverride ReadOnly Property AreDriversBeingInstalled As Boolean
	Get
```

--------------------------------

### HIDSharp: GetFeature Method

Source: https://docs.zer7.com/hidsharp/html/799b52a4-8e16-28bf-b004-f407110192ff

Sends a 'Get Feature' setup request to the HID device. This is used to retrieve specific feature data from the device.

```C#
public abstract int GetFeature(byte[] buffer, int offset, int count);
```

--------------------------------

### Initialize HidDeviceInputReceiver with ReportDescriptor (F#)

Source: https://docs.zer7.com/hidsharp/html/e31f8a17-1977-955d-3d92-dc751bcf67c9

Constructs a HidDeviceInputReceiver using a ReportDescriptor in F#. This function signature defines how to create an instance of the input receiver with the necessary report descriptor.

```fsharp
new :
        reportDescriptor : ReportDescriptor -> HidDeviceInputReceiver
```

--------------------------------

### AreDriversBeingInstalled Property (C++)

Source: https://docs.zer7.com/hidsharp/html/3096cc52-ee8a-529e-050b-be6d48691872

Provides a virtual property to get a boolean value indicating the status of driver installation. This is an override of a base class property.

```C++
public:
	virtual property bool AreDriversBeingInstalled {
		bool get () override;
	}
```

--------------------------------

### TryOpen Method Signature (C++)

Source: https://docs.zer7.com/hidsharp/html/67c8689e-42e1-1c5a-3e06-86d6eb869753

The C++ signature for the TryOpen method, designed for opening HID devices and providing a DeviceStream.

```cpp
bool TryOpen(
	OpenConfiguration^ openConfig,
	[OutAttribute] DeviceStream^% stream
)
```

--------------------------------

### TryOpen Method Signature in F#

Source: https://docs.zer7.com/hidsharp/html/ba411697-db18-8b7c-423d-f76350c38c41

This F# signature for the TryOpen method shows how to open a HID device. It uses byref parameters for the stream and exception.

```fsharp
member TryOpen : 
        openConfig : OpenConfiguration * 
        stream : DeviceStream byref * 
        exception : Exception byref -> bool 
```

--------------------------------

### HidrawApi Guid Property in F#

Source: https://docs.zer7.com/hidsharp/html/4dac7988-42f9-eb26-bb36-6cc672ef74fe

This snippet shows how to access the HidrawApi Guid property in F#, which represents the Linux hidraw API.

```F#
static member HidrawApi : Guid with get
```

--------------------------------

### Open HID Device Connection (C#)

Source: https://docs.zer7.com/hidsharp/html/e47a3f3e-3da6-7738-d276-0c1a87792e44

Establishes a connection to the HID device using C#. Returns a DeviceStream for communication. Ensure the HidSharp assembly is referenced.

```csharp
public DeviceStream Open()
```

--------------------------------

### Initialize HidDeviceInputReceiver with ReportDescriptor (C#)

Source: https://docs.zer7.com/hidsharp/html/e31f8a17-1977-955d-3d92-dc751bcf67c9

Constructs a HidDeviceInputReceiver using a ReportDescriptor. This is essential for setting up input handling for HID devices.

```csharp
public HidDeviceInputReceiver(
	ReportDescriptor reportDescriptor
)
```

--------------------------------

### HidrawApi Guid Property in C++

Source: https://docs.zer7.com/hidsharp/html/4dac7988-42f9-eb26-bb36-6cc672ef74fe

This snippet shows how to access the HidrawApi Guid property in C++, which represents the Linux hidraw API.

```C++
public:
	static property Guid HidrawApi {
		Guid get ();
	}
```

--------------------------------

### HidrawApi Guid Property in C#

Source: https://docs.zer7.com/hidsharp/html/4dac7988-42f9-eb26-bb36-6cc672ef74fe

This snippet shows how to access the HidrawApi Guid property in C#, which represents the Linux hidraw API.

```C#
public static Guid HidrawApi { get; }
```

--------------------------------

### HidrawApi Guid Property in VB

Source: https://docs.zer7.com/hidsharp/html/4dac7988-42f9-eb26-bb36-6cc672ef74fe

This snippet shows how to access the HidrawApi Guid property in Visual Basic, which represents the Linux hidraw API.

```VB
Public Shared ReadOnly Property HidrawApi As Guid
	Get
```

--------------------------------

### LogicalFromCustom C# Implementation

Source: https://docs.zer7.com/hidsharp/html/9c543352-14f6-b996-1f48-b250e36d5061

This C# code snippet demonstrates the signature of the LogicalFromCustom method, which takes a DataItem, physical value, minimum, and maximum to return an integer logical value.

```csharp
public static int LogicalFromCustom(
	DataItem item,
	double physicalValue,
	double minimum,
	double maximum
)
```

--------------------------------

### Get Serial Number - C#

Source: https://docs.zer7.com/hidsharp/html/814c2b19-20a1-4571-f382-70aa95eefdbe

This C# code snippet shows how to get the serial number of a HID device using the GetSerialNumber() method.

```C#
public abstract string GetSerialNumber()
```

--------------------------------

### Try Get Serial Device - HIDSharp

Source: https://docs.zer7.com/hidsharp/html/6d1968e9-dcd5-e05f-8f9c-836d2b7a70ae

Attempts to get a connected serial device. The specific criteria for matching are not detailed in the provided documentation.

```C#
DeviceList.TryGetSerialDevice()
```

--------------------------------

### CreateIOException Method - HIDSharp

Source: https://docs.zer7.com/hidsharp/html/6c056fb8-d492-862b-388a-e3f3649bb29b

Initializes a new instance of the IOException class, associating a Device with it. Overloads are provided to include additional string information and an integer.

```C#
public static IOException CreateIOException(Device device, string message)
public static IOException CreateIOException(Device device, string message, int hresult)
```

```VB
Public Shared Function CreateIOException(device As Device, message As String) As IOException
Public Shared Function CreateIOException(device As Device, message As String, hresult As Integer) As IOException
```

--------------------------------

### HidSharp ReportDescriptor Methods

Source: https://docs.zer7.com/hidsharp/index

Offers methods for creating input receivers and retrieving report information from a report descriptor. `CreateHidDeviceInputReceiver` is used to set up a listener for device input.

```C#
CreateHidDeviceInputReceiver Method 
GetReport Method 
TryGetReport Method
```

--------------------------------

### Try Get HID Device - HIDSharp

Source: https://docs.zer7.com/hidsharp/html/6d1968e9-dcd5-e05f-8f9c-836d2b7a70ae

Attempts to get a connected HID device. The specific criteria for matching are not detailed in the provided documentation.

```C#
DeviceList.TryGetHidDevice()
```

--------------------------------

### Get ValueCount in F# - HidSharp

Source: https://docs.zer7.com/hidsharp/html/691c2cc5-ee45-98f6-18ce-44fc107e18f8

The F# representation of the ValueCount property returns the number of unique values in the DeviceItem. It is defined with a get accessor.

```F#
member ValueCount : int with get
```

--------------------------------

### Initialize HidDeviceInputReceiver with ReportDescriptor (C++)

Source: https://docs.zer7.com/hidsharp/html/e31f8a17-1977-955d-3d92-dc751bcf67c9

Constructs a HidDeviceInputReceiver using a ReportDescriptor in C++. This allows for the initialization of the input receiver based on the device's report structure.

```cpp
public:
HidDeviceInputReceiver(
	ReportDescriptor^ reportDescriptor
)
```

--------------------------------

### TryOpen HID Device (F#)

Source: https://docs.zer7.com/hidsharp/html/a6c330fc-3e6c-2448-67ab-47f8dc90a3d8

Attempts to open a HID device and returns a HidStream. This is the F# implementation.

```F#
member TryOpen :
        stream : HidStream byref -> bool
```

--------------------------------

### Start HidDeviceInputReceiver

Source: https://docs.zer7.com/hidsharp/html/3c090e05-bc3b-ca1f-daaa-1cb19c04502f

Starts the HidDeviceInputReceiver. The receiver will continue operating until the stream is closed or the device is disconnected. It is recommended to call TryRead to process incoming HID reports.

```C#
receiver.Start();
```

--------------------------------

### OpenOption.Guid Property Syntax

Source: https://docs.zer7.com/hidsharp/html/6f4c5dfb-d22b-40e5-b14a-2b32ac25a68a

Provides the syntax for accessing the Guid property of the OpenOption class in various .NET languages. This property returns a Guid representing the option.

```C#
public Guid Guid { get; }
```

```VB
Public ReadOnly Property Guid As Guid
	Get
```

```C++
public:
	property Guid Guid {
		Guid get ();
	}
```

```F#
member Guid : Guid with get
```

--------------------------------

### Open HID Device Connection (VB)

Source: https://docs.zer7.com/hidsharp/html/e47a3f3e-3da6-7738-d276-0c1a87792e44

Establishes a connection to the HID device using VB.NET. Returns a DeviceStream for communication. Ensure the HidSharp assembly is referenced.

```vb
Public Function Open As DeviceStream
```

--------------------------------

### TimeExponent Property in F#

Source: https://docs.zer7.com/hidsharp/html/5754a013-4cd2-c6f8-0d99-385ab33f92e2

The TimeExponent property in F# allows you to get or set the exponent of the report value's units of time. It is an int property with get and set accessors.

```F#
member TimeExponent : int with get, set
```

--------------------------------

### Get Specific Serial Device - HIDSharp

Source: https://docs.zer7.com/hidsharp/html/6d1968e9-dcd5-e05f-8f9c-836d2b7a70ae

Gets the connected serial device with the specific port name. This method is useful for directly accessing a serial port and is part of the DeviceList class.

```C#
DeviceList.GetSerialDeviceOrNull()
```

--------------------------------

### TryOpen HID Device (C++)

Source: https://docs.zer7.com/hidsharp/html/a6c330fc-3e6c-2448-67ab-47f8dc90a3d8

Attempts to open a HID device and returns a HidStream. This is the C++ implementation.

```C++
public:
bool TryOpen(
	[OutAttribute] HidStream^% stream
)
```

--------------------------------

### TryOpen Method in C++ - HIDSharp

Source: https://docs.zer7.com/hidsharp/html/bbe8a22a-fc81-1643-a489-81c5c52c30d3

The C++ version of the TryOpen method, designed to open a HID device. It takes an OpenConfiguration and returns a HidStream via a reference parameter, indicating success with a boolean.

```C++
public:
bool TryOpen(
	OpenConfiguration^ openConfig,
	[OutAttribute] HidStream^% stream
)
```

--------------------------------

### Get First Matching HID Device - HIDSharp

Source: https://docs.zer7.com/hidsharp/html/6d1968e9-dcd5-e05f-8f9c-836d2b7a70ae

Gets the first connected HID device that matches the specified criteria. This method is useful for finding a specific HID device and is part of the DeviceList class.

```C#
DeviceList.GetHidDeviceOrNull()
```

--------------------------------

### UnitExponent Property in F#

Source: https://docs.zer7.com/hidsharp/html/95f6e6ef-25de-3178-e81e-2c4ab4336c96

Gets or sets the unit exponent for the DataItem in F#.

```F#
member UnitExponent : int with get, set
```

--------------------------------

### Open Device Connection

Source: https://docs.zer7.com/hidsharp/html/f6e0bf9a-1756-9f1a-6efb-655eead62b70

Provides the method signature for opening a HID device connection using the OpenConfiguration. Supported in C#, VB, C++, and F#.

```C#
public DeviceStream Open(
	OpenConfiguration openConfig
)
```

```VB
Public Function Open (
	openConfig As OpenConfiguration
) As DeviceStream
```

```C++
public:
DeviceStream^ Open(
	OpenConfiguration^ openConfig
)
```

```F#
member Open :
        openConfig : OpenConfiguration -> DeviceStream
```

--------------------------------

### TryOpen Method Signature in C++

Source: https://docs.zer7.com/hidsharp/html/ba411697-db18-8b7c-423d-f76350c38c41

This C++ signature for the TryOpen method illustrates opening a HID device using managed C++. It employs reference parameters for stream and exception.

```cpp
public: bool TryOpen(
	OpenConfiguration^ openConfig, 
	[OutAttribute] DeviceStream^% stream, 
	[OutAttribute] Exception^% exception
)
```

--------------------------------

### UnitExponent Property in C++

Source: https://docs.zer7.com/hidsharp/html/95f6e6ef-25de-3178-e81e-2c4ab4336c96

Gets or sets the unit exponent for the DataItem in C++.

```C++
public:
	property int UnitExponent {
		int get ();
		void set (int value);
	}
```

--------------------------------

### LogicalFromCustom C++ Implementation

Source: https://docs.zer7.com/hidsharp/html/9c543352-14f6-b996-1f48-b250e36d5061

This C++ code snippet presents the signature for the LogicalFromCustom method, facilitating the conversion of physical measurements to logical values within the HidSharp library.

```cpp
public:
static int LogicalFromCustom(
	DataItem^ item,
	double physicalValue,
	double minimum,
	double maximum
)
```

--------------------------------

### UnitExponent Property in VB

Source: https://docs.zer7.com/hidsharp/html/95f6e6ef-25de-3178-e81e-2c4ab4336c96

Gets or sets the unit exponent for the DataItem in VB.NET.

```VB
Public Property UnitExponent As Integer
	Get
	Set
```

--------------------------------

### TryOpen HidDevice

Source: https://docs.zer7.com/hidsharp/index

Offers methods to attempt opening a HidDevice, returning a boolean indicating success or failure. This is useful for non-blocking device access.

```C#
public HidStream TryOpen (OpenConfiguration configuration, HidStream stream)
public HidStream TryOpen (HidStream stream)
public HidStream TryOpen ()
```

--------------------------------

### UnitExponent Property in C#

Source: https://docs.zer7.com/hidsharp/html/95f6e6ef-25de-3178-e81e-2c4ab4336c96

Gets or sets the unit exponent for the DataItem in C#.

```C#
public int UnitExponent { get; set; }
```

--------------------------------

### Get Device Manufacturer

Source: https://docs.zer7.com/hidsharp/html/8048f117-2419-b61a-43f2-bce2a0c10838

Retrieves the name of the manufacturer for the HID device.

```C#
string GetManufacturer();
```

--------------------------------

### HidSharp DeviceItem Methods

Source: https://docs.zer7.com/hidsharp/index

Provides methods for interacting with HID devices, including parsing input reports. The `CreateHidDeviceInputReceiver` method is key for setting up a mechanism to receive input reports from a device.

```C#
CreateDeviceItemInputParser Method
```

--------------------------------

### IndexRange.Minimum Property (F#)

Source: https://docs.zer7.com/hidsharp/html/5cbd7244-2edb-3c40-bfa9-0801e263db93

Gets or sets the minimum index for the report in F#.

```F#
member Minimum : uint32 with get, set
```

--------------------------------

### TryOpen Method in C# - HIDSharp

Source: https://docs.zer7.com/hidsharp/html/bbe8a22a-fc81-1643-a489-81c5c52c30d3

Attempts to open a HID device using the specified OpenConfiguration. If successful, it returns true and provides a HidStream. This is a common way to establish communication with a HID device.

```C#
public bool TryOpen(
	OpenConfiguration openConfig,
	out HidStream stream
)
```

--------------------------------

### IndexRange.Minimum Property (C++)

Source: https://docs.zer7.com/hidsharp/html/5cbd7244-2edb-3c40-bfa9-0801e263db93

Gets or sets the minimum index for the report in C++.

```C++
public:
	property unsigned int Minimum {
		unsigned int get ();
		void set (unsigned int value);
	}
```

--------------------------------

### Try Open HID Device Connection - C#

Source: https://docs.zer7.com/hidsharp/html/9e927672-1711-43e5-b7d0-d301a65d0838

Attempts to establish a connection to the HID device without throwing an exception. Returns a DeviceStream if successful.

```C#
bool TryOpen(out DeviceStream stream);
```

```C#
bool TryOpen(OpenConfiguration configuration, out DeviceStream stream);
```

--------------------------------

### Create OpenOption from GUID (VB)

Source: https://docs.zer7.com/hidsharp/html/685592e7-b4fa-a406-1561-f9d02a0293bd

This VB.NET code snippet shows how to use the FromGuid method to create an OpenOption object from a System.Guid.

```VB
Public Shared Function FromGuid (
	guid As Guid
) As OpenOption
```

--------------------------------

### IndexRange.Minimum Property (VB)

Source: https://docs.zer7.com/hidsharp/html/5cbd7244-2edb-3c40-bfa9-0801e263db93

Gets or sets the minimum index for the report in VB.NET.

```VB
Public Property Minimum As UInteger
	Get
	Set
End Property
```

--------------------------------

### IndexRange.Minimum Property (C#)

Source: https://docs.zer7.com/hidsharp/html/5cbd7244-2edb-3c40-bfa9-0801e263db93

Gets or sets the minimum index for the report in C#.

```C#
public uint Minimum { get; set; }
```

--------------------------------

### Create IOException with Device and String - HIDSharp

Source: https://docs.zer7.com/hidsharp/html/cee72e52-3e11-199c-b46e-23627fac6a69

Initializes a new instance of the IOException class, associating a Device and a string message with it.

```C#
public static IOException CreateIOException(Device device, string message)
```

--------------------------------

### TryOpen HID Device (C#)

Source: https://docs.zer7.com/hidsharp/html/a6c330fc-3e6c-2448-67ab-47f8dc90a3d8

Attempts to open a HID device and returns a HidStream. This is the C# implementation.

```C#
public bool TryOpen(
	out HidStream stream
)
```

--------------------------------

### IndexList.Count Property (F#)

Source: https://docs.zer7.com/hidsharp/html/098ec6d4-9e8e-f5f2-57c2-a88339ae0e81

Gets the number of items in the collection. This is a read-only property.

```F#
abstract Count : int with get
override Count : int with get
```

--------------------------------

### IndexList.Count Property (C++)

Source: https://docs.zer7.com/hidsharp/html/098ec6d4-9e8e-f5f2-57c2-a88339ae0e81

Gets the number of items in the collection. This is a read-only property.

```C++
public:
	virtual property int Count {
		int get () override;
	}
```

--------------------------------

### Create IOException with Device, String, and Int32 - HIDSharp

Source: https://docs.zer7.com/hidsharp/html/cee72e52-3e11-199c-b46e-23627fac6a69

Initializes a new instance of the IOException class, associating a Device, a string message, and an integer error code with it.

```C#
public static IOException CreateIOException(Device device, string message, int errorCode)
```

--------------------------------

### TryOpen Method Signature (F#)

Source: https://docs.zer7.com/hidsharp/html/67c8689e-42e1-1c5a-3e06-86d6eb869753

The F# signature for the TryOpen method, which facilitates opening HID devices and returning a DeviceStream.

```fsharp
member TryOpen :
        openConfig : OpenConfiguration * 
        stream : DeviceStream byref -> bool 

```

--------------------------------

### IndexList.Count Property (VB)

Source: https://docs.zer7.com/hidsharp/html/098ec6d4-9e8e-f5f2-57c2-a88339ae0e81

Gets the number of items in the collection. This is a read-only property.

```VB
Public Overrides ReadOnly Property Count As Integer
	Get
```

--------------------------------

### IndexList.Count Property (C#)

Source: https://docs.zer7.com/hidsharp/html/098ec6d4-9e8e-f5f2-57c2-a88339ae0e81

Gets the number of items in the collection. This is a read-only property.

```C#
public override int Count { get; }
```

--------------------------------

### CreateIOException Method in C++

Source: https://docs.zer7.com/hidsharp/html/3c7a81a8-89ca-080f-4c8b-92597e179d1e

Creates an IOException instance for a given device and error message in C++.

```cpp
public:
static IOException^ CreateIOException(
	Device^ device, 
	String^ message
)
```
Tokens:
Raw