CommonDialog.ShowAcquireImage method
Displays one or more dialog boxes that enable the user to acquire an image from a hardware device.
Syntax
ppResult = .ShowAcquireImage( _
[ ByVal DeviceType As WiaDeviceType ], _
[ ByVal Intent As WiaImageIntent ], _
[ ByVal Bias As WiaImageBias ], _
[ ByVal FormatID As BSTR ], _
[ ByVal AlwaysSelectDevice As VARIANT_BOOL ], _
[ ByVal UseCommonUI As VARIANT_BOOL ], _
[ ByVal CancelError As VARIANT_BOOL ] _
) As HRESULT
Parameters
-
DeviceType [in, optional]
-
Type: WiaDeviceType
WiaDeviceType value.
Value Meaning - UnspecifiedDeviceType
Default. The device type is unknown. -
Intent [in, optional]
-
Type: WiaImageIntent
WiaImageIntent value.
Value Meaning - UnspecifiedIntent
Default. No intent specified. -
Bias [in, optional]
-
Type: WiaImageBias
WiaImageBias value.
Value Meaning - MaximizeQuality
Default. Use a higher quality scan to maximize the quality of the image. -
FormatID [in, optional]
-
Type: BSTR
String value that specifies one of the FormatID Constants that indicates the requested image format.
Value Meaning - {00000000-0000-0000-0000-000000000000}
Default. Unspecified format. -
AlwaysSelectDevice [in, optional]
-
Type: VARIANT_BOOL
Boolean value that indicates whether to always show the select device dialog box.
Value Meaning - False
Default. Do not show the select device dialog box. - True
Show the select device dialog box. -
UseCommonUI [in, optional]
-
Type: VARIANT_BOOL
Boolean value that indicates whether to use the common UI.
Value Meaning - False
Do not use the common UI. - True
Default. Use the common UI. -
CancelError [in, optional]
-
Type: VARIANT_BOOL
Boolean value that indicates whether to generate an error if the user cancels the dialog box.
Value Meaning - False
Default. Do not generate an error. - True
Generate an error.
Return value
Type: ImageFile**
Returns an ImageFile object on success, otherwise returns Nothing.
Remarks
For example code, see Convert a File in Shared Samples.
Requirements
| Minimum supported client |
Windows Vista [desktop apps only] |
| Minimum supported server |
Windows Server 2003 R2 [desktop apps only] |
| Header |
|
| IDL |
|