AcquireFileEvent Event

Occurs for each page acquired from the currently selected WIA source using the AcquireToFile method and it will also get called for each end of page to provide the user with the EndOfPage flag through the Flags member of the WiaAcquireFileEventArgs event argument to indicate the end of each page transfer.

Syntax

Visual Basic
C#
WinRT C#
WinRT JavaScript
C++

public event EventHandler<WiaAcquireFileEventArgs> AcquireFileEvent

'Declaration
 
Public Event AcquireFileEvent As EventHandler(Of WiaAcquireFileEventArgs)

'Usage
 
Dim instance As WiaSession
Dim handler As EventHandler(Of WiaAcquireFileEventArgs)
 
AddHandler instance.AcquireFileEvent, handler

public event EventHandler<WiaAcquireFileEventArgs> AcquireFileEvent

add_AcquireFileEvent(function(sender, e))
remove_AcquireFileEvent(function(sender, e))

public:
event EventHandler<WiaAcquireFileEventArgs^>^ AcquireFileEvent

Event Data

The event handler receives an argument of type WiaAcquireFileEventArgs containing data related to this event. The following WiaAcquireFileEventArgs properties provide information specific to this event.

Property	Description
Cancel	Aborts the acquire operation.
FileName	Indicates the full filename and path into which the current scanning operation is saving the page(s) that are being acquired.
Flags	Indicates the start and the end of each acquired page.
Percent	Indicates the percent completion of the acquisition process from the WIA source.

Remarks

If the user acquired several pages at the same time, a separate event occurs for each page.

For more information, refer to How to Acquire from the WIA Source.

Example

Refer to WiaSession.AcquireToFile.

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

WiaSession Class
WiaSession Members
Startup Method
Shutdown Method
SelectDevice Method
SelectDeviceDlg Method
AcquireToFile Method