Click or drag to resize

RigelDockUsbDetails Class

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice
      Crestron.SimplSharpProUsbHid
        Crestron.SimplSharpPro.UIRigelDockUsbDetails

Namespace: Crestron.SimplSharpPro.UI
Assembly: Crestron.SimplSharpPro.UI (in Crestron.SimplSharpPro.UI.dll) Version: 2.21.121
Syntax
C#
public sealed class UsbDetails : UsbHid

The RigelDockUsbDetails type exposes the following members.

Properties
 NameDescription
Public propertyConnectedIpList A property containing the list of the ConnectedIpInformation objects which contain information about the devices that are connected to this IP ID. This property is only valid for an ethernet device. If this is not an ethernet device, then this property will return null. If this is an ethernet device, the list will be non-null. It will be empty if no devices are connected. The order of items in this list is not guaranteed.
(Inherited from GenericDevice)
Public propertyCountryCodeFeedback Get the country code specified by the HID attached to the port.

The BaseEvent event will trigger with CountryCodeFeedbackEventId.


(Inherited from UsbHid)
Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyFeatureReport Feature report that can be sent to the HID attached to the port.
(Inherited from UsbHid)
Public propertyFeatureReportFeedback Feature reports specified by the HID attached to the port.

The BaseEvent event will trigger with FeatureReportFeedbackEventId.


(Inherited from UsbHid)
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyInputReportFeedback Input report specified by the HID attached to the port.

The BaseEvent event will trigger with InputReportFeedbackEventId.


(Inherited from UsbHid)
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyManufacturerFeedback Get the manufacturer specified by the HID attached to the port.

The BaseEvent event will trigger with ManufacturerFeedbackEventId.


(Inherited from UsbHid)
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyOutputReport Output report that can be sent to the HID attached to the port.
(Inherited from UsbHid)
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyPortNumber USB Port Number.
(Inherited from UsbHid)
Public propertyProductFeedback Get the product name specified by the HID attached to the port.

The BaseEvent event will trigger with ProductFeedbackEventId.


(Inherited from UsbHid)
Public propertyRegisterable Property to indicate that this device can be registered.
(Inherited from GenericDevice)
Public propertyRegistered Property to get the current registration state of the device.
(Inherited from GenericDevice)
Public propertyRegistrationFailureReason Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice)
Public propertyReportDescriptorFeedback Report descriptor specified by the HID attached to the port.

The BaseEvent event will trigger with ReportDescriptorFeedbackEventId.


(Inherited from UsbHid)
Public propertySerialNumberFeedback Get the serial number specified by the HID attached to the port.

The BaseEvent event will trigger with SerialNumberFeedbackEventId.


(Inherited from UsbHid)
Public propertyType Property to determine to type of device this is.
(Inherited from GenericDevice)
Public propertyUnRegistrationFailureReason Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice)
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from GenericBase)
Top
Methods
 NameDescription
Public methodDispose Clean up of resources.
(Inherited from GenericBase)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodToString Return the name of the device.
(Inherited from GenericDevice)
Public methodUnRegister Unregister this device with the system. This function can not be called from the device's own SigChange event handler.

On successful unregistration, if this device supports the OnlineStatusChange event, it will trigger indicating the device when offline.


(Inherited from GenericDevice)
Top
Events
 NameDescription
Public eventBaseEvent Generic base event, triggered when the there are no other handlers available for a specific EventID.
(Inherited from GenericBase)
Public eventIpInformationChange Event that tells what IP Address is connected/disconnected from an IP ID for a non-UDP device. This is only valid for an Ethernet device. An exception will be thrown if it is not.
(Inherited from GenericDevice)
Public eventOnlineStatusChange Event triggered when the Online status of the device changes.
(Inherited from GenericDevice)
Top

Version Information

.NET

Supported in: 6.0
See Also