Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

WIA.ItemPropertyKeys

Queries list of properties.

Component Version macOS Windows Linux Server iOS SDK
WIA 6.5 ❌ No ✅ Yes ❌ No ❌ No ❌ No
MBS( "WIA.ItemPropertyKeys"; Item )   More

Parameters

Parameter Description Example
Item The item of current device to query.
For a scanner this is typical Flatbed or Feeder.
see WIA.ListItems
"Flatbed"

Result

Returns list or error.

Description

Queries list of properties.
Use WIA.ItemProperties to query all values with keys as JSON.

Examples

List properties of Flatbed unit:

MBS( "WIA.ItemPropertyKeys"; "Flatbed" )

Example result:
Item Name
Full Item Name
Item Flags
Color Profile Name
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
Item Category
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

List properties of feeder:

Set Variable [ $item ; Value: "Feeder" ]
Set Variable [ $list ; Value: MBS("WIA.ItemPropertyKeys"; $item) ]
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.ItemPropertyValue"; $item; $key) ]
            New Record/Request
            Set Field [ WIA Scan::Device ; $item ]
            Set Field [ WIA Scan::Key ; $key ]
            Set Field [ WIA Scan::Value ; $value ]
            Commit Records/Requests [ With dialog: Off ]
            # Next
            Set Variable [ $i ; Value: $i+1 ]
            Exit Loop If [ $i > $count ]
        End Loop
    End If
End If

See also

Blog Entries

This function checks for a license.

Created 28th November 2016, last changed 15th November 2019


WIA.ItemProperties - WIA.ItemPropertyValue