LEADTOOLS WIA(Leadtools.Wiaアセンブリ)

フレームを表示

Acquireメソッド






アプリケーションウィンドウのウィンドウハンドル。

スキャナー装置とShowUserInterfaceフラグから取得することが設定されないとき、このパラメーターが使われるだけです。スキャナの給紙口(フィーダーまたはフラットベッド)を指定するために、このパラメーターを使います。

このフラグはオプションです。WIA 1.0を使っているならば、根本の項目のために、または、利用できるスキャナ項目を列挙して、スキャニングのために使われる項目を渡すことによってWiaPropertyId.ScannerDeviceDocumentHandlingSelect属性値を変更することによって、給紙口を変更することができます。

WIAを使っているならば、2.0は利用できるスキャナ項目も列挙して、スキャニングのために使われる項目も渡すか、null(Visual BasicではNothing)も渡します、その場合には、列挙体は内部的に実行されます、そして、最初の列挙された項目がソース項目として使われます。

WIA画像獲得選択ダイアログボックスの特定の動作を決定するフラグ。設定可能な値は、以下の通りです。

意味

WiaAcquireFlags.None デバイス画像獲得ダイアログボックスのためのデフォルト動作。
WiaAcquireFlags.SingleImage デバイス画像獲得ダイアログボックスでimage選択を単一のimageに制限します。WIAバージョン2.0を使っているならば、このフラグは利用できません。
WiaAcquireFlags.ShowUserInterface メーカーの画像獲得ダイアログボックスを示します。
WiaAcquireFlags.UseCommonUI 利用可能な場合、ベンダーが提供するユーザーインターフェース(UI)でなく、システムユーザーインターフェースを使用します。システムUIが利用できないならば、ベンダーUIが使われます。
WIAソースから一つ以上のイメージを取得します。
構文
public DialogResult Acquire( 
   IntPtr owner,
   object item,
   WiaAcquireFlags flags
)
'Declaration
 
Public Function Acquire( _
   ByVal owner As IntPtr, _
   ByVal item As Object, _
   ByVal flags As WiaAcquireFlags _
) As DialogResult
'Usage
 
Dim instance As WiaSession
Dim owner As IntPtr
Dim item As Object
Dim flags As WiaAcquireFlags
Dim value As DialogResult
 
value = instance.Acquire(owner, item, flags)

            

            
public:
DialogResult Acquire( 
   IntPtr owner,
   Object^ item,
   WiaAcquireFlags flags
) 

パラメーター

オーナー
アプリケーションウィンドウのウィンドウハンドル。
項目

スキャナー装置とShowUserInterfaceフラグから取得することが設定されないとき、このパラメーターが使われるだけです。スキャナの給紙口(フィーダーまたはフラットベッド)を指定するために、このパラメーターを使います。

このフラグはオプションです。WIA 1.0を使っているならば、根本の項目のために、または、利用できるスキャナ項目を列挙して、スキャニングのために使われる項目を渡すことによってWiaPropertyId.ScannerDeviceDocumentHandlingSelect属性値を変更することによって、給紙口を変更することができます。

WIAを使っているならば、2.0は利用できるスキャナ項目も列挙して、スキャニングのために使われる項目も渡すか、null(Visual BasicではNothing)も渡します、その場合には、列挙体は内部的に実行されます、そして、最初の列挙された項目がソース項目として使われます。

フラグ
WIA画像獲得選択ダイアログボックスの特定の動作を決定するフラグ。設定可能な値は、以下の通りです。

意味

WiaAcquireFlags.None デバイス画像獲得ダイアログボックスのためのデフォルト動作。
WiaAcquireFlags.SingleImage デバイス画像獲得ダイアログボックスでimage選択を単一のimageに制限します。WIAバージョン2.0を使っているならば、このフラグは利用できません。
WiaAcquireFlags.ShowUserInterface メーカーの画像獲得ダイアログボックスを示します。
WiaAcquireFlags.UseCommonUI 利用可能な場合、ベンダーが提供するユーザーインターフェース(UI)でなく、システムユーザーインターフェースを使用します。システムUIが利用できないならば、ベンダーUIが使われます。

戻り値

DialogResult値の1つ。エラーが発生するならば、例外はスローされます。
解説

この関数は、選択したWIAデバイスから単一であるか複数のイメージを取得します。

WiaSession.Startupを呼び出し、その後、この関数を呼び出す前に、いずれかのWiaSession.SelectDeviceDlgまたはWiaSession.SelectDevice関数を呼び出します。

WIAソースから取得している間、若干のオプションを制御するためにこのメソッドを呼び出す前にAcquireOptionsプロパティメンバを変更することができます。

以下の1つを実行することによって、メモリ転送またはファイル転送のためにこのメソッドを設定します:

メモリ転送を実行するとき、収集されたページを受け取るためにAcquireEventイベントを追加する必要があります。イベントは、ページ転送進捗のパーセント完了を提供もします。

ファイル転送を実施する場合、AcquireEventイベントの追加はオプションです。イベントにより保存されたパスと、ファイル保存処理が何パーセント完了したかが示されるだけであるためです。

ファイル転送を実行するとき、WiaSessionクラスの範囲内の2つのプロパティは利用できるようになります:

収集操作をキャンセルするために、AcquireEventイベントを追加して、WiaAcquireEventArgsキャンセルメンバをtrueに設定する必要があります。

注意:

ShowUserInterfaceフラグが収集メソッドのいずれかのために設定されるならば、以前に設定された/変更されたユーザープロパティ(SetPropertyXxxまたはSetPropertiesメソッドのどれでも使う)のいくらかがMicrosoftの画像獲得ダイアログボックスで上書きされるのでご了承ください。Microsoftの画像獲得ダイアログボックスは、現在の意図(image型)、選択領域(left、上、幅と高さ)、給紙口とデュプレックスモードのようなそれ自身の初期化プロパティを設定します、 ...その他。

メーカーの画像取得ダイアログを押して、SetPropertyXxxとSetPropertiesメソッドを通して設定された値を使用して項目パラメーターを通して指定されたソース項目から直接取得するには、ShowUserInterfaceフラグを設定しないでください。

注意: Windows VISTA 64ビットの上でこの関数を呼び出すWin32バージョンアプリケーションを実行している間、FilesCountFilesPathsプロパティが必要情報で更新されないことがわかりました。これは、MicrosoftのWIAツールキットの既知の制限です。
注意: WIA 2.0を使っている、そして、ShowUserInterfaceフラグが設定されるならば、AcquireEventイベントを追加することが必要でありません。MicrosoftのWIA 2.0収集ダイアログは、イベントを提供しないで、すべての処理を実行して、FilesCountFilesPathsプロパティを通して、保存されるファイルの数のカウントとパスで返ります。

詳細については、「WIAソースから取得する方法」を参照してください。

サンプル
WiaSession.IsAvailableを参照してください
必要条件

ターゲットプラットホーム

参照

参照

WiaSessionクラス
WiaSessionメンバ
Startupメソッド
Shutdownメソッド
SelectDeviceメソッド
SelectDeviceDlgメソッド
AcquireToFileメソッド
AcquireSimpleメソッド
AcquireOptionsプロパティ
FilesCountプロパティ
FilesPathsプロパティ
GetPropertiesメソッド
SetPropertiesメソッド