Class UsbDevice

Definition

Namespace:: Tizen.System.Usb

Assembly:: Tizen.System.Usb.dll

A class to manage the USB host devices. This class contains the operations for enumerating, opening, and closing devices.


                C#
                
                    Copy
                    
                
            
public class UsbDevice : IDisposable

Inheritance: object

UsbDevice

Implements: System.IDisposable

Properties

View Source

ActiveConfiguration

Active configuration for the device.

Declaration


                C#
                
                    Copy
                    
                
            
public UsbConfiguration ActiveConfiguration { get; }

Property Value

Type	Description
UsbConfiguration

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.
System.InvalidOperationException	Throws exception if device is disconnected or not opened for operation.

View Source

Address

Address of the device on the bus.

Declaration


                C#
                
                    Copy
                    
                
            
public int Address { get; }

Property Value

Type	Description
int

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.

View Source

BusId

Number of the bus, this device is connected to.

Declaration


                C#
                
                    Copy
                    
                
            
public int BusId { get; }

Property Value

Type	Description
int

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.
System.UnauthorizedAccessException	Throws exception if user has insufficient permission on device.

View Source

Configurations

A dictionary for mapping the configuration IDs to configuration instances for this device.

Declaration


                C#
                
                    Copy
                    
                
            
public IReadOnlyDictionary<int, UsbConfiguration> Configurations { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyDictionary<TKey, TValue><int, UsbConfiguration>

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.

View Source

ControlEndpoint

Controls an endpoint (endpoint 0).

Declaration


                C#
                
                    Copy
                    
                
            
public UsbControlEndpoint ControlEndpoint { get; }

Property Value

Type	Description
UsbControlEndpoint

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.

View Source

DeviceInformation

Device information such as version, class, subclass, etc.

Declaration


                C#
                
                    Copy
                    
                
            
public UsbDeviceInformation DeviceInformation { get; }

Property Value

Type	Description
UsbDeviceInformation

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.

View Source

IsOpened

Checks if the device is opened.

Declaration


                C#
                
                    Copy
                    
                
            
public bool IsOpened { get; }

Property Value

Type	Description
bool

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.

View Source

Ports

List of the available port numbers from the device.

Declaration


                C#
                
                    Copy
                    
                
            
public IEnumerable<int> Ports { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<T><int>

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.

View Source

Strings

String associated with the device.

Declaration


                C#
                
                    Copy
                    
                
            
public UsbDeviceStrings Strings { get; }

Property Value

Type	Description
UsbDeviceStrings

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.
System.InvalidOperationException	Throws exception if device is disconnected or not opened for operation.

Methods

View Source

Close()

Closes the device for operations.

Declaration


                C#
                
                    Copy
                    
                
            
public void Close()

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.

View Source

Dispose()

Releases all the resources used by the ConnectionProfile. It should be called after it has finished using the object.

Declaration


                C#
                
                    Copy
                    
                
            
public void Dispose()

View Source

~UsbDevice()

Finalizes an instance of the UsbDevice class.

Declaration


                C#
                
                    Copy
                    
                
            
protected ~UsbDevice()

View Source

Open()

Opens the device, which allows performing operations on it.

Declaration


                C#
                
                    Copy
                    
                
            
public void Open()

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.
System.OutOfMemoryException	Throws an exception in case of insufficient memory.
System.InvalidOperationException	Throws an exception if the device is disconnected.
System.UnauthorizedAccessException	Throws an exception if the user has insufficient permission on the device.

Implements

System.IDisposable