Mac OS X
Components Crossplatform Mac & Win Server Client Old Guides Examples
New in version: 7.1 7.2 7.3 7.4 7.5 8.0 8.1 8.2 8.3 8.4 Statistic
Queries information about device.
|Component||Version||macOS||Windows||Server||FileMaker Cloud||FileMaker iOS SDK|
|Device||The device ID.
Can be zero based index in device list.
Or UUID, Name or persitent ID string.
|Selector||Which value to query.||"name"|
The type of image to return. Either JPEG, PNG, GIF or BMP. Default is JPEG.
The filename to use for the picture. Default is "image" with the extension matching the image type.
Returns OK or error.
DescriptionQueries information about device.
|availableFunctionalUnitTypes||The available functional unit types for scanner. This can include Flatbed, DocumentFeeder, NegativeTransparency or PositiveTransparency.||"Flatbed¶DocumentFeeder"|
|name||Name of the device as reported by the device module or by the device transport when a device module is not in control of this device. This name may change if the device module overrides the default name of the device reported by the device's transport, or if the name of the filesystem volume mounted by the device is changed by the user.||"Brother DCP-8085DN"|
|type||The type of the device. Camera or Scanner||"Scanner"|
|modulePath||Filesystem path of the device module that is associated with this device.|
|moduleVersion||The bundle version of the device module associated with this device.||"1.0"|
|remote||Indicates whether the device is a remote device published by Image Capture device sharing facility. Can be 1 or 0.||1|
|shared||Indicates whether the device is shared using the Image Capture device sharing facility. Can be 1 or 0.||1|
|hasConfigurableWiFiInterface||Indicates whether the device can be configured for use on a WiFi network.||0|
|transportType||The transport type used by the device. Can be USB, Bluetooth, TCPIP, MassStorage.||"USB"|
|serialNumberString||The serial number of the device. This will be NULL if the device does not provide a serial number.||"12345"|
|locationDescription||A non-localized location description string for the device.||"Best Scanner"|
|persistentIDString||A string representation of the persistent ID of the device.||"61B0A8E1-61B0-A8E1-61B0-A8E161B0A8E1"|
|UUIDString||A string representation of the Universally Unique ID of the device.||"61B0A8E1-61B0-A8E1-61B0-A8E161B0A8E1"|
|hasOpenSession||Indicates whether the device has an open session. Can be 1 or 0.||0|
|icon||Icon image for the device.|
|moduleExecutableArchitecture||Executable Architecture of the device module in control of this device.|
|usbLocationID||The USB location ID of a USB device in the IOKit registry. This will be 0 for non-USB devices.|
|usbProductID||The USB product ID of a USB device in the IOKit registry. This will be 0 for non-USB devices.|
|usbVendorID||The USB vendor ID of a USB device in the IOKit registry. This will be 0 for non-USB devices.|
|fwGUID||The FireWire GUID of a FireWire device in the IOKit registry. This will be 0 for non-FireWire devices.|
|buttonPressed||A string object with one of the ICButtonType* values defined above.|
|autolaunchApplicationPath||Filesystem path of an application that is to be automatically launched when this device is added.|
|capabilities||The capabilities of the device as reported by the device module.|
Added with plugin version 7.0: bonjourServiceName, bonjourServiceType, iconPath, ipAddress and productKind.
Query remote status for first device:
Query shared status for first device:
Query serial number for first device:
Query location description for a device:
Query capabilities for a device:
Created 11st September 2016, last changed 6th June 2018
Feedback: Report problem or ask question.
MBS Xojo Plugins