Class UsbDevice
Definition
- Assembly:
- Tizen.System.Usb.dll
A class to manage the USB host devices. This class contains the operations for enumerating, opening, and closing devices.
public class UsbDevice : IDisposable
- Inheritance
-
objectUsbDevice
- Implements
-
System.IDisposable
Properties
View SourceActiveConfiguration
Active configuration for the device.
Declaration
public UsbConfiguration ActiveConfiguration { get; }
Property Value
Type | Description |
---|---|
UsbConfiguration |
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Throws an exception if the device is disconnected. |
Address
Address of the device on the bus.
Declaration
public int Address { get; }
Property Value
Type | Description |
---|---|
int |
BusId
Number of the bus, this device is connected to.
Declaration
public int BusId { get; }
Property Value
Type | Description |
---|---|
int |
Exceptions
Type | Condition |
---|---|
System.UnauthorizedAccessException | Throws an exception if the user has insufficient permission on the device. |
Configurations
A dictionary for mapping the configuration IDs to configuration instances for this device.
Declaration
public IReadOnlyDictionary<int, UsbConfiguration> Configurations { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IReadOnlyDictionary<TKey, TValue><int, UsbConfiguration> |
ControlEndpoint
Controls an endpoint (endpoint 0).
Declaration
public UsbControlEndpoint ControlEndpoint { get; }
Property Value
Type | Description |
---|---|
UsbControlEndpoint |
DeviceInformation
Device information such as version, class, subclass, etc.
Declaration
public UsbDeviceInformation DeviceInformation { get; }
Property Value
Type | Description |
---|---|
UsbDeviceInformation |
IsOpened
Checks if the device is opened.
Declaration
public bool IsOpened { get; }
Property Value
Type | Description |
---|---|
bool |
Ports
List of the available port numbers from the device.
Declaration
public IEnumerable<int> Ports { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<T><int> |
Strings
String associated with the device.
Declaration
public UsbDeviceStrings Strings { get; }
Property Value
Type | Description |
---|---|
UsbDeviceStrings |
Methods
View SourceClose()
Closes the device for operations.
Declaration
public void Close()
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Throws an exception if the device is not opened for an operation. |
Dispose()
Releases all the resources used by the ConnectionProfile. It should be called after it has finished using the object.
Declaration
public void Dispose()
Dispose(bool)
Releases all the resources used by the ConnectionProfile. It should be called after it has finished using the object.
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
bool | disposing |
~UsbDevice()
Finalizes an instance of the UsbDevice class.
Declaration
protected ~UsbDevice()
Open()
Opens the device, which allows performing operations on it.
Declaration
public void Open()
Exceptions
Type | Condition |
---|---|
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. |