Edit

WIA Event Identifiers

  • Article

WIA event identifiers are globally unique identifiers (GUID) defined by the Windows Image Acquisition (WIA) system.

A WIA application can subscribe to these non-persistent events by using IwiaDevMgr2::RegisterEventCallbackInterface to receive device status change notifications from the WIA device to which the current WIA application session is connected. The WIA mini-driver must ensure that WIA_DPS_DOCUMENT_HANDLING_STATUS is correctly updated before the driver signals one of these events.

The following are valid WIA event GUIDs:

GUID Meaning
WIA_EVENT_CANCEL_IO The application attempts to cancel a data transfer.
WIA_EVENT_COVER_CLOSED All scanner covers are closed. If there were multiple scanner covers opened, the WIA minidriver should signal this event only when the last cover was closed. This feature is available starting with Windows 8.
WIA_EVENT_COVER_OPEN A scanner cover was opened by the operator. The device cannot scan at this time. The WIA minidriver should signal this event only once if multiple scanner covers are opened in succession. This feature is available starting with Windows 8.
WIA_EVENT_DEVICE_CONNECTED A WIA hardware device was connected to the user's computer or started.
WIA_EVENT_DEVICE_DISCONNECTED A WIA hardware device was disconnected from the user's computer or stopped.
WIA_EVENT_DEVICE_NOT_READY The device entered not-ready state. The application should read WIA_DPS_DOCUMENT_HANDLING_STATUS for more information. This feature is available starting with Windows 8.
WIA_EVENT_DEVICE_READY The device entered ready state. The previous not-ready state signaled with WIA_EVENT_DEVICE_NOT_READY was cleared. This feature is available starting with Windows 8.
WIA_EVENT_FEEDER_EMPTIED The operator removed all documents from the feeder input tray and the feeder is empty. The device cannot scan from the feeder at this time. Important: the minidriver must not signal this event when the feeder becomes empty as result of a scan job executed by an application. This feature is available starting with Windows 8.
WIA_EVENT_FEEDER_LOADED The operator placed documents in the feeder input tray. The feeder is loaded with paper. The application can initiate a scan job from the feeder at this time. This feature is available starting with Windows 8.
WIA_EVENT_FLATBED_LID_CLOSED The flatbed lid was closed by the operator. The application can initiate a scan job from the flatbed at this time. This feature is available starting with Windows 8.
WIA_EVENT_FLATBED_LID_OPEN The flatbed lid was opened by the operator. The device cannot scan from the flatbed at this time. This feature is available starting with Windows 8.
WIA_EVENT_ITEM_CREATED An item was added to the tree of IWiaItem or IWiaItem2 objects for a WIA device.
WIA_EVENT_ITEM_DELETED An item was deleted from the tree of IWiaItem or IWiaItem2 objects for a WIA device.
WIA_EVENT_POWER_RESUME Power has been restored to the device or computer.
WIA_EVENT_POWER_SUSPEND Power has been suspended to the device or computer.
WIA_EVENT_SCAN_EMAIL_IMAGE A scan was initiated with the intent to e-mail the resulting image.
WIA_EVENT_SCAN_FAX_IMAGE A scan was initiated with the intent to fax the resulting image.
WIA_EVENT_SCAN_FILM_IMAGE An image was scanned from a film adapter.
WIA_EVENT_SCAN_IMAGE An image was scanned.
WIA_EVENT_SCAN_IMAGE2 An image was scanned. This event allows scanners with more than one scan button to direct the buttons to different applications.
WIA_EVENT_SCAN_IMAGE3 An image was scanned. This event allows scanners with more than one scan button to direct the buttons to different applications.
WIA_EVENT_SCAN_IMAGE4 An image was scanned. This event allows scanners with more than one scan button to direct the buttons to different applications.
WIA_EVENT_SCAN_OCR_IMAGE A scan was initiated with the intent to convert the resulting image with optical character recognition (OCR).
WIA_EVENT_SCAN_PRINT_IMAGE A scan was initiated with the intent to print the resulting image.
WIA_EVENT_STI_PROXY Intended for internal use only. Do not use.
WIA_EVENT_STORAGE_CREATED A storage unit, such as a flash card, was added to the device. The application should re-create the item tree that represents this device.
WIA_EVENT_STORAGE_DELETED A storage unit, such as a flash card, was removed from the device. The application should re-create the item tree that represents this device.
WIA_EVENT_TREE_UPDATED The WIA item tree was updated.
WIA_EVENT_VOLUME_INSERTED A storage device, such as a flash card, was inserted into the device.