Class ConnectedDeviceDefinition

Represents the definition of a device that has been physically connected and has a DeviceId

Inheritance

System.Object

ConnectedDeviceDefinition

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: Device.Net

Assembly: Device.Net.dll

Syntax

public class ConnectedDeviceDefinition

Constructors

ConnectedDeviceDefinition(String, DeviceType, Nullable<UInt32>, Nullable<UInt32>, String, String, String, Nullable<UInt16>, Nullable<UInt16>, Nullable<UInt16>, Nullable<Int32>, Nullable<Int32>, String, Nullable<Guid>)

Declaration

public ConnectedDeviceDefinition(string deviceId, DeviceType deviceType, uint? vendorId = null, uint? productId = null, string productName = null, string manufacturer = null, string serialNumber = null, ushort? usage = null, ushort? usagePage = null, ushort? versionNumber = null, int? writeBufferSize = null, int? readBufferSize = null, string label = null, Guid? classGuid = null)

Parameters

Type	Name	Description
System.String	deviceId
DeviceType	deviceType
System.Nullable<System.UInt32>	vendorId
System.Nullable<System.UInt32>	productId
System.String	productName
System.String	manufacturer
System.String	serialNumber
System.Nullable<System.UInt16>	usage
System.Nullable<System.UInt16>	usagePage
System.Nullable<System.UInt16>	versionNumber
System.Nullable<System.Int32>	writeBufferSize
System.Nullable<System.Int32>	readBufferSize
System.String	label
System.Nullable<System.Guid>	classGuid

Properties

ClassGuid

Declaration

public Guid? ClassGuid { get; }

Property Value

Type	Description
System.Nullable<System.Guid>

DeviceId

The device Id or path specific to the platform for the device

Declaration

public string DeviceId { get; }

Property Value

Type	Description
System.String

DeviceType

The type of device interface

Declaration

public DeviceType DeviceType { get; }

Property Value

Type	Description
DeviceType

Label

Freeform tag to be used as needed

Declaration

public string Label { get; }

Property Value

Type	Description
System.String

Manufacturer

Name of the device's manufacturer

Declaration

public string Manufacturer { get; }

Property Value

Type	Description
System.String

ProductId

Product Id

Declaration

public uint? ProductId { get; }

Property Value

Type	Description
System.Nullable<System.UInt32>

ProductName

The name of the device product according to the Manufacturer

Declaration

public string ProductName { get; }

Property Value

Type	Description
System.String

ReadBufferSize

The maximum size of data to be read from the device

Declaration

public int? ReadBufferSize { get; }

Property Value

Type	Description
System.Nullable<System.Int32>

SerialNumber

Unique serial number of the physical device

Declaration

public string SerialNumber { get; }

Property Value

Type	Description
System.String

Usage

Declaration

public ushort? Usage { get; }

Property Value

Type	Description
System.Nullable<System.UInt16>

UsagePage

Used to further filter down device definitions on some platforms

Declaration

public ushort? UsagePage { get; }

Property Value

Type	Description
System.Nullable<System.UInt16>

VendorId

Vendor ID

Declaration

public uint? VendorId { get; }

Property Value

Type	Description
System.Nullable<System.UInt32>

VersionNumber

Device version number

Declaration

public ushort? VersionNumber { get; }

Property Value

Type	Description
System.Nullable<System.UInt16>

WriteBufferSize

The maximum size of data to be written to the device

Declaration

public int? WriteBufferSize { get; }

Property Value

Type	Description
System.Nullable<System.Int32>

Methods

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()