ShowAcquireImage Method

Displays one or more dialog boxes that enable the user to acquire an image from a hardware device.

Syntax

  object.ShowAcquireImage( _
    [DeviceType As WiaDeviceType,] _
    [Intent As WiaImageIntent,] _
    [Bias As WiaImageBias,] _
    [FormatID As String,] _
    [AlwaysSelectDevice As Boolean,] _
    [UseCommonUI As Boolean,] _
    [CancelError As Boolean]) As ImageFile

Parameters

• DeviceType
  Optional. WiaDeviceType value.

  • UnspecifiedDeviceType
    Default. The device type is unknown.

• Intent
  Optional. WiaImageIntent value.

  • UnspecifiedIntent
    Default. No intent specified.

• Bias
  Optional. WiaImageBias value.

  • MaximizeQuality
    Default. Use a higher quality scan to maximize the quality of the image.

• FormatID
  Optional. String value that specifies one of the FormatID Constants that indicates the requested image format.

  • {00000000-0000-0000-0000-000000000000}
    Default. Unspecified format.

• AlwaysSelectDevice
  Optional. Boolean value that indicates whether to always show the select device dialog box.

  • False
    Default. Do not show the select device dialog box.
  • True
    Show the select device dialog box.

• UseCommonUI
  Optional. Boolean value that indicates whether to use the common user interface (UI).

  • False
    Do not use the common UI.
  • True
    Default. Use the common UI.

• CancelError
  Optional. Boolean value that indicates whether to generate an error if the user cancels the dialog box.

  • False
    Default. Do not generate an error.
  • True
    Generate an error.

Return Value

Returns an ImageFile object on success, otherwise returns Nothing.

Remarks

For example code, see Convert a File in Shared Samples.

Method Information

Minimum operating systems

Windows XP SP1

See Also

CommonDialog, ShowSelectDevice, ShowSelectItems, ShowTransfer, Type (Device), Type (DeviceInfo), FormatID Constants, ImageFile, FormatID, Apply, Transfer, ImageFile (Vector), WiaDeviceType, WiaImageBias, WiaImageIntent