|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.virtualbox_7_0.IUnknown
org.virtualbox_7_0.IUSBDeviceFilter
public class IUSBDeviceFilter
The IUSBDeviceFilter interface represents a USB device filter used to perform actions on one or more USB devices. USB device filters are used by running virtual machines to automatically capture selected USB devices once they are physically attached to the host computer. A USB device is matched to a specific device filter if and only if all attributes of the device filter match the corresponding attributes of the device (that is, attributes are joined together using a logical AND operation). On the other hand filter attributes in separate USB device filters are applied as a logical OR operation. So if one would like to create a match such as "this vendor id OR this product id", then one would need to create two filters and specify "any match" (see below) for the other unused attributes. All filter attributes used for matching are strings. The following filtering expressions are currently supported:
int:((m)|([m]-[n]))(,(m)|([m]-[n]))*
wherem
andn
are integer numbers, either in octal
(starting with0
), hexadecimal (starting with0x
)
or decimal (otherwise), so thatm < n
. Ifm
is omitted before a dash (-
), the minimum possible integer
is assumed; ifn
is omitted after a dash, the maximum
possible integer is assumed.true|false|yes|no|0|1
int:
represents an exact match. String device attributes are compared to
this string in a case-sensitive manner. Integer attributes are first
converted to a string (see individual filter attributes) and then
compared in a case-insensitive manner.getManufacturer()
,getProduct()
,getSerialNumber()
) are ignored, so they behave asany matchno matter what string expression is specified.
IUSBDeviceFilters.getDeviceFilters()
,
Interface ID: {45587218-4289-EF4E-8E6A-E5B07816B631}
Field Summary |
---|
Fields inherited from class org.virtualbox_7_0.IUnknown |
---|
obj, objMgr, port |
Constructor Summary | |
---|---|
IUSBDeviceFilter(java.lang.String wrapped,
org.virtualbox_7_0.ObjectRefManager objMgr,
org.virtualbox_7_0.jaxws.VboxPortType port)
|
Method Summary | |
---|---|
java.lang.Boolean |
getActive()
Whether this filter active or has been temporarily disabled. |
java.lang.String |
getManufacturer()
IUSBDevice.getManufacturer() filter. |
java.lang.Long |
getMaskedInterfaces()
This is an advanced option for hiding one or more USB interfaces from the guest. |
java.lang.String |
getName()
Visible name for this filter. |
java.lang.String |
getPort()
IUSBDevice.getPort() filter. |
java.lang.String |
getProduct()
IUSBDevice.getProduct() filter. |
java.lang.String |
getProductId()
IUSBDevice.getProductId() filter. |
java.lang.String |
getRemote()
IUSBDevice.getRemote() filter. |
java.lang.String |
getRevision()
IUSBDevice.getProductId() filter. |
java.lang.String |
getSerialNumber()
IUSBDevice.getSerialNumber() filter. |
java.lang.String |
getVendorId()
IUSBDevice.getVendorId() filter. |
static IUSBDeviceFilter |
queryInterface(IUnknown obj)
|
void |
setActive(java.lang.Boolean value)
Whether this filter active or has been temporarily disabled. |
void |
setManufacturer(java.lang.String value)
IUSBDevice.getManufacturer() filter. |
void |
setMaskedInterfaces(java.lang.Long value)
This is an advanced option for hiding one or more USB interfaces from the guest. |
void |
setName(java.lang.String value)
Visible name for this filter. |
void |
setPort(java.lang.String value)
IUSBDevice.getPort() filter. |
void |
setProduct(java.lang.String value)
IUSBDevice.getProduct() filter. |
void |
setProductId(java.lang.String value)
IUSBDevice.getProductId() filter. |
void |
setRemote(java.lang.String value)
IUSBDevice.getRemote() filter. |
void |
setRevision(java.lang.String value)
IUSBDevice.getProductId() filter. |
void |
setSerialNumber(java.lang.String value)
IUSBDevice.getSerialNumber() filter. |
void |
setVendorId(java.lang.String value)
IUSBDevice.getVendorId() filter. |
Methods inherited from class org.virtualbox_7_0.IUnknown |
---|
getObjMgr, getRemoteWSPort, getWrapped, releaseRemote |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IUSBDeviceFilter(java.lang.String wrapped, org.virtualbox_7_0.ObjectRefManager objMgr, org.virtualbox_7_0.jaxws.VboxPortType port)
Method Detail |
---|
public java.lang.String getName()
public void setName(java.lang.String value)
value
- Stringpublic java.lang.Boolean getActive()
public void setActive(java.lang.Boolean value)
value
- Booleanpublic java.lang.String getVendorId()
IUSBDevice.getVendorId()
filter.
The string representation for theexact matchinghas the formXXXX
, whereX
is the hex digit
(including leading zeroes).
public void setVendorId(java.lang.String value)
IUSBDevice.getVendorId()
filter.
The string representation for theexact matchinghas the formXXXX
, whereX
is the hex digit
(including leading zeroes).
value
- Stringpublic java.lang.String getProductId()
IUSBDevice.getProductId()
filter.
The string representation for theexact matchinghas the formXXXX
, whereX
is the hex digit
(including leading zeroes).
public void setProductId(java.lang.String value)
IUSBDevice.getProductId()
filter.
The string representation for theexact matchinghas the formXXXX
, whereX
is the hex digit
(including leading zeroes).
value
- Stringpublic java.lang.String getRevision()
IUSBDevice.getProductId()
filter. The string representation for theexact matchinghas the formIIFF
, whereI
is the decimal digit
of the integer part of the revision, andF
is the
decimal digit of its fractional part (including leading and
trailing zeros).
Note that for interval filters, it's best to use the hexadecimal
form, because the revision is stored as a 16 bit packed BCD value;
so the expressionint:0x0100-0x0199
will match any
revision from1.0
to1.99
.
public void setRevision(java.lang.String value)
IUSBDevice.getProductId()
filter. The string representation for theexact matchinghas the formIIFF
, whereI
is the decimal digit
of the integer part of the revision, andF
is the
decimal digit of its fractional part (including leading and
trailing zeros).
Note that for interval filters, it's best to use the hexadecimal
form, because the revision is stored as a 16 bit packed BCD value;
so the expressionint:0x0100-0x0199
will match any
revision from1.0
to1.99
.
value
- Stringpublic java.lang.String getManufacturer()
IUSBDevice.getManufacturer()
filter.
public void setManufacturer(java.lang.String value)
IUSBDevice.getManufacturer()
filter.
value
- Stringpublic java.lang.String getProduct()
IUSBDevice.getProduct()
filter.
public void setProduct(java.lang.String value)
IUSBDevice.getProduct()
filter.
value
- Stringpublic java.lang.String getSerialNumber()
IUSBDevice.getSerialNumber()
filter.
public void setSerialNumber(java.lang.String value)
IUSBDevice.getSerialNumber()
filter.
value
- Stringpublic java.lang.String getPort()
IUSBDevice.getPort()
filter.
public void setPort(java.lang.String value)
IUSBDevice.getPort()
filter.
value
- Stringpublic java.lang.String getRemote()
IUSBDevice.getRemote()
filter.
NOTE: This filter makes sense only for machine USB filters,
i.e. it is ignored by IHostUSBDeviceFilter objects.
public void setRemote(java.lang.String value)
IUSBDevice.getRemote()
filter.
NOTE: This filter makes sense only for machine USB filters,
i.e. it is ignored by IHostUSBDeviceFilter objects.
value
- Stringpublic java.lang.Long getMaskedInterfaces()
public void setMaskedInterfaces(java.lang.Long value)
value
- Longpublic static IUSBDeviceFilter queryInterface(IUnknown obj)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |