Topics   All   MacOS (Only)   Windows (Only)   Linux (Only, Not)   iOS (Only, Not)  
Components   Crossplatform Mac & Win   Server   Client   Old   Deprecated   Guides   Examples   Videos
New in version: 9.3   9.4   9.5   10.0   10.1   10.2   10.3   10.4   10.5   10.6    Statistic    FMM    Blog  

ImageCapture.DeviceInfo

Queries information about device.

Component Version macOS Windows Server FileMaker Cloud FileMaker iOS SDK
ImageCapture 6.4 Yes No No No No
MBS( "ImageCapture.DeviceInfo"; Device; Selector { ; ImageType; FileName } )   More

Parameters

Parameter Description Example Flags
Device The device ID.
Can be zero based index in device list.
Or UUID, Name or persitent ID string.
0
Selector Which value to query. "name"
ImageType The type of image to return.
Either JPEG, PNG, GIF or BMP. Default is JPEG.
"JPEG" Optional
FileName The filename to use for the picture.
Default is "image" with the extension matching the image type.
"test.jpg" Optional

Result

Returns OK or error.

Description

Queries information about device.

SelectorDescriptionExample
availableFunctionalUnitTypesThe available functional unit types for scanner. This can include Flatbed, DocumentFeeder, NegativeTransparency or PositiveTransparency."Flatbed¶DocumentFeeder"
nameName 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"
typeThe type of the device. Camera or Scanner"Scanner"
modulePathFilesystem path of the device module that is associated with this device.
moduleVersionThe bundle version of the device module associated with this device."1.0"
remoteIndicates whether the device is a remote device published by Image Capture device sharing facility. Can be 1 or 0.1
sharedIndicates whether the device is shared using the Image Capture device sharing facility. Can be 1 or 0.1
hasConfigurableWiFiInterfaceIndicates whether the device can be configured for use on a WiFi network.0
transportTypeThe transport type used by the device. Can be USB, Bluetooth, TCPIP, MassStorage."USB"
serialNumberStringThe serial number of the device. This will be NULL if the device does not provide a serial number."12345"
locationDescriptionA non-localized location description string for the device."Best Scanner"
persistentIDStringA string representation of the persistent ID of the device."61B0A8E1-61B0-A8E1-61B0-A8E161B0A8E1"
UUIDStringA string representation of the Universally Unique ID of the device."61B0A8E1-61B0-A8E1-61B0-A8E161B0A8E1"
hasOpenSessionIndicates whether the device has an open session. Can be 1 or 0.0
iconIcon image for the device.
moduleExecutableArchitectureExecutable Architecture of the device module in control of this device.
usbLocationIDThe USB location ID of a USB device in the IOKit registry. This will be 0 for non-USB devices.
usbProductIDThe USB product ID of a USB device in the IOKit registry. This will be 0 for non-USB devices.
usbVendorIDThe USB vendor ID of a USB device in the IOKit registry. This will be 0 for non-USB devices.
fwGUIDThe FireWire GUID of a FireWire device in the IOKit registry. This will be 0 for non-FireWire devices.
buttonPressedA string object with one of the ICButtonType* values defined above.
autolaunchApplicationPathFilesystem path of an application that is to be automatically launched when this device is added.
capabilitiesThe capabilities of the device as reported by the device module.

Added with plugin version 7.0: bonjourServiceName, bonjourServiceType, iconPath, ipAddress and productKind.

New for macOS 11.0: systemSymbolName allows to query standard system symbol used to represent the device class. Using the symbol to render an appropriate device icon will ensure proper scaling for high resolution devices.

Examples

Query remote status for first device:

MBS("ImageCapture.DeviceInfo"; 0; "remote")

Query shared status for first device:

MBS("ImageCapture.DeviceInfo"; 0; "shared")

Query serial number for first device:

MBS("ImageCapture.DeviceInfo"; 0; "serialNumberString")

Query location description for a device:

MBS("ImageCapture.DeviceInfo"; "61B0A8E1-61B0-A8E1-61B0-A8E161B0A8E1"; "locationDescription")

Query capabilities for a device:

MBS("ImageCapture.DeviceInfo"; "61B0A8E1-61B0-A8E1-61B0-A8E161B0A8E1"; "capabilities")

See also

Example Databases

Blog Entries

Release notes

Created 11st September 2016, last changed 11st November 2020


ImageCapture.Contents   -   ImageCapture.Devices

Feedback: Report problem or ask question.




Links
MBS FileMaker Plugins