org.virtualbox_5_2
Class IUSBDeviceFilters
java.lang.Object
org.virtualbox_5_2.IUnknown
org.virtualbox_5_2.IUSBDeviceFilters
public class IUSBDeviceFilters
- extends IUnknown
Constructor Summary |
IUSBDeviceFilters(java.lang.String wrapped,
org.virtualbox_5_2.ObjectRefManager objMgr,
org.virtualbox_5_2.jaxws.VboxPortType port)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
IUSBDeviceFilters
public IUSBDeviceFilters(java.lang.String wrapped,
org.virtualbox_5_2.ObjectRefManager objMgr,
org.virtualbox_5_2.jaxws.VboxPortType port)
getDeviceFilters
public java.util.List<IUSBDeviceFilter> getDeviceFilters()
- List of USB device filters associated with the machine.
If the machine is currently running, these filters are activated
every time a new (supported) USB device is attached to the host
computer that was not ignored by global filters
(
IHost.getUSBDeviceFilters()
).
These filters are also activated when the machine is powered up.
They are run against a list of all currently available USB
devices (in statesUSBDeviceState.Available
,USBDeviceState.Busy
,USBDeviceState.Held
) that were not previously
ignored by global filters.
If at least one filter matches the USB device in question, this
device is automatically captured (attached to) the virtual USB
controller of this machine.
- Returns:
- List<org.virtualbox_5_2.IUSBDeviceFilter>
- See Also:
IUSBDeviceFilter
,
IUSBController
queryInterface
public static IUSBDeviceFilters queryInterface(IUnknown obj)
createDeviceFilter
public IUSBDeviceFilter createDeviceFilter(java.lang.String name)
- Creates a new USB device filter. All attributes except
the filter name are set to empty (any match),activeis false (the filter is not active).
The created filter can then be added to the list of filters using
insertDeviceFilter(Long,org.virtualbox_5_2.IUSBDeviceFilter)
.
- Parameters:
name
- Filter name. SeeIUSBDeviceFilter.getName()
for more info.
- Returns:
- Created filter object.
Expected result codes:
VBOX_E_INVALID_VM_STATE | The virtual machine is not mutable. |
- See Also:
getDeviceFilters()
insertDeviceFilter
public void insertDeviceFilter(java.lang.Long position,
IUSBDeviceFilter filter)
- Inserts the given USB device to the specified position
in the list of filters.
Positions are numbered starting from0. If the specified
position is equal to or greater than the number of elements in
the list, the filter is added to the end of the collection.
- Parameters:
position
- Position to insert the filter to.filter
- USB device filter to insert.
Expected result codes:
VBOX_E_INVALID_VM_STATE | Virtual machine is not mutable. |
E_INVALIDARG | USB device filter not created within this VirtualBox instance. |
VBOX_E_INVALID_OBJECT_STATE | USB device filter already in list. |
NOTE: Duplicates are not allowed, so an attempt to insert a
filter that is already in the collection, will return an
error.- See Also:
getDeviceFilters()
removeDeviceFilter
public IUSBDeviceFilter removeDeviceFilter(java.lang.Long position)
- Removes a USB device filter from the specified position in the
list of filters.
Positions are numbered starting from0. Specifying a
position equal to or greater than the number of elements in
the list will produce an error.
- Parameters:
position
- Position to remove the filter from.
- Returns:
- Removed USB device filter.
Expected result codes:
VBOX_E_INVALID_VM_STATE | Virtual machine is not mutable. |
E_INVALIDARG | USB device filter list empty or invalid position. |
- See Also:
getDeviceFilters()