| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
WIA.DevicePropertyKeys
Queries the property keys for the device.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| WIA | 6.5 | ❌ No | ✅ Yes | ❌ No | ❌ No | ❌ No |
Parameters
| Parameter | Description | Example |
|---|---|---|
| Device | You can pass index of device to check them in a row. Or pass name or unique ID of device. Pass empty string for current device. |
$index |
Result
Returns list or error.
Description
Queries the property keys for the device.The current device (connected) may show more device properties than just the information from the registry, which you get without connection.
Use WIA.DeviceProperties to query all values with keys as JSON.
Examples
Query properties of current device:
MBS( "WIA.DevicePropertyKeys"; "" )
Example result:
Item Name
Full Item Name
Item Flags
Unique Device ID
Manufacturer
Description
Type
Port
Name
Server
Remote Device ID
UI Class ID
Hardware Configuration
BaudRate
STI Generic Capabilities
WIA Version
Driver Version
PnP ID String
STI Driver Version
User Name
Item Category
Document Handling Capabilities
Document Handling Status
Max Scan Time
Access Rights
Horizontal Optical Resolution
Vertical Optical Resolution
Preview
Show preview control
Maximum Horizontal Scan Size
Maximum Vertical Scan Size
Minimum Vertical Scan Size
Minimum Horizontal Scan Size
Horizontal Bed Registration
Vertical Bed Registration
Page Size
Current Intent
Firmware Version
Horizontal Resolution
Vertical Resolution
Horizontal Start Position
Vertical Start Position
Horizontal Extent
Vertical Extent
Rotation
Orientation
DeskewX
DeskewY
Brightness
Contrast
Item Size
Data Type
Bits Per Pixel
Preferred Format
Format
Compression
Photometric Interpretation
Lamp Warm up Time
Media Type
Channels Per Pixel
Bits Per Channel
Planar
Pixels Per Line
Number of Lines
Bytes Per Line
Threshold
Buffer Size
Filename extension
Sheet Feeder Registration
Pages
Document Handling Select
Page Width
Page Height
List properties:
Set Variable [$device; Value:Get(ScriptParameter)]
Set Variable [$list; Value:MBS("WIA.DevicePropertyKeys"; $device)]
If [MBS("IsError")]
Show Custom Dialog ["Error"; $list]
Else
Set Variable [$count; Value:ValueCount ( $list )]
If [$count > 0]
Set Variable [$i; Value:1]
Loop
Set Variable [$key; Value:GetValue ( $list; $i)]
Set Variable [$value; Value:MBS("WIA.DevicePropertyValue"; $device; $key)]
New Record/Request
Set Field [WIA Scan::Device; $device]
Set Field [WIA Scan::Key; $key]
Set Field [WIA Scan::Value; $value]
Commit Records/Requests [No dialog]
#Next
Set Variable [$i; Value:$i+1]
Exit Loop If [$i > $count]
End Loop
End If
End If
See also
Example Databases
This function checks for a license.
Created 6th November 2016, last changed 9th November 2021
