OpenOption Class

HIDSharp

Options for opening a device stream.

Inheritance Hierarchy

SystemObject
HidSharpOpenOption

Namespace: HidSharp
Assembly: HidSharp (in HidSharp.dll) Version: 2.0.0

Syntax

public sealed class OpenOption

Public NotInheritable Class OpenOption

public ref class OpenOption sealed

[<SealedAttribute>]
type OpenOption =  class end

The OpenOption type exposes the following members.

Methods

	Name	Description
	Deserialize
	Equals	(Overrides ObjectEquals(Object).)
	FromGuid
	GetHashCode	(Overrides ObjectGetHashCode.)
	New
	Serialize
	ToString	(Overrides ObjectToString.)

Properties

	Name	Description
	DefaultValue
	Exclusive	Use HIDSharp's exclusivity layer. This allows one process using HIDSharp to lock other processes out of using a HID device. Processes may request interruption, allowing interprocess cooperation. (For example, a data logging application can make itself interruptible and allow another process to use the HID device temporarily.) Defaults to false.
	FriendlyName
	Guid
	Interruptible	Allow other processes to send interruption requests. If another other process with higher priority attempts to open the HID device this process is using, this process will receive an InterruptRequested event on an arbitrary thread. Exclusive must be true for this to work. Defaults to false.
	Priority	The priority of the process. This is used for interruption requests. Exclusive must be true for this to work. Defaults to Normal.
	TimeoutIfInterruptible	The amount of time to wait for an interruptible process to give up the HID device before failing to open the stream. Defaults to 3000 milliseconds.
	TimeoutIfTransient	The amount of time to wait for a transient process to give up the HID device before failing to open the stream. Defaults to 30000 milliseconds.
	Transient	If a HID device is opened by another process transiently, HIDSharp will wait some time for the process to give up the HID device before failing to open the stream. Exclusive must be true for this to work. Defaults to false.