←Select platform
In This Topic ▼

WiaSession Class Members

Summary

The following tables list the members exposed by WiaSession.

Public Constructors

Name Description
Public Constructor WiaSession Constructs a new WiaSession object with default values.

Public Methods

Name Description
Public Method Acquire Acquires one or more images from a WIA source.
Public Method AcquireImageFromVideo Extracts a still image from the video stream, and saves the image as a JPEG file.
Public Method AcquireSimple Acquires one or more images from a WIA source.
Public Method AcquireToFile Acquires one or more images from a WIA source directly to file(s).
Public Method EndVideoPreview Shuts down the streaming video.
Public Method EnumCapabilities Enumerates all of the available WIA driver capabilities and properties and determines the available values for each one.
Public Method EnumChildItems Enumerates all available child items for the root item specified in the parentItem parameter.
Public Method EnumDevices Enumerates all available system WIA devices connected to the user's machine.
Public Method EnumFormats Enumerates all of the available WIA driver transfer formats.
Public Method FreeItem Frees the items enumerated by the EnumChildItems method.
Public Method static  | Shared in VB GetCategoryGuid Retrieves the relevant System.Guid structure for the WIA 2.0 item's category.
Public Method static  | Shared in VB GetFormatGuid Retrieves the relevant System.Guid structure for the passed file format ID.
Public Method GetProperties Gets the properties for the specified item.
Public Method GetPropertyBuffer Retrieves the Stream buffer for any WiaVariableTypes.UI1 or WiaVariableTypes.Vector property.
Public Method GetPropertyGuid Retrieves the Guid structure for any WiaVariableTypes.Clsid property.
Public Method static  | Shared in VB GetPropertyIdString Gets the equivalent string for the passed property ID.
Public Method GetPropertyLong Retrieves the Long value for a WIA property of any of the following types: WiaVariableTypes.I1, WiaVariableTypes.UI1, WiaVariableTypes.I2, WiaVariableTypes.UI2, WiaVariableTypes.I4, WiaVariableTypes.UI4, WiaVariableTypes.Int, WiaVariableTypes.UInt, WiaVariableTypes.R4, or WiaVariableTypes.R8.
Public Method GetPropertyString Retrieves a string buffer for any WiaVariableTypes.Bstr property.
Public Method GetPropertySystemTime Retrieves a System.DateTime structure for any WiaVariableTypes.UI2 or WiaVariableTypes.Vector property.
Public Method GetRootItem Gets the equivalent string for the passed property ID.
Public Method GetSelectedDevice Gets a string that contains the ID for currently selected device.
Public Method static  | Shared in VB IsAvailable Determines which version of the WIA source is installed.
Public Method IsVideoPreviewAvailable Determines whether there is an available video preview.
Public Method ResizeVideoPreview Resizes the video playback to the largest supported resolution that fits inside the parent window.
Public Method SelectDevice Selects the WIA device represented by the passed device ID.
Public Method SelectDeviceDlg Displays a dialog box that enables the user to select a WIA hardware device for image acquisition.
Public Method SetProperties Sets the values of the properties to the values specified in the WiaProperties structure into the WIA device's item passed through the item parameter.
Public Method SetPropertyBuffer Fills the Stream buffer for any WiaVariableTypes.UI1 or WiaVariableTypes.Vector property.
Public Method SetPropertyGuid Sets WiaVariableTypes.Clsid property values.
Public Method SetPropertyLong Sets the Long value for the WiaVariableTypes.I1, WiaVariableTypes.UI1, WiaVariableTypes.I2, WiaVariableTypes.UI2, WiaVariableTypes.I4, WiaVariableTypes.UI4, WiaVariableTypes.Int, WiaVariableTypes.UInt, WiaVariableTypes.R4, and WiaVariableTypes.R8 properties.
Public Method SetPropertyString Sets a string value for any WIA property of type WiaVariableTypes.Bstr that is not Read only.
Public Method SetPropertySystemTime Sets the date and time of the specified item in the form of a System.DateTime structure for WiaVariableTypes.UI2 or WiaVariableTypes.Vector properties.
Public Method Shutdown Ends a WIA session.
Public Method Startup Initializes the WIA session.
Public Method StartVideoPreview Starts the video preview inside the window handle specified through the owner parameter.

Protected Methods

Name Description
Protected Method Dispose This member supports the Leadtools infrastructure and is not intended to be used directly from your code.
Protected Method Finalize This member overrides the System.Object.Finalize method.

Public Properties

Name Description
Public Property AcquireOptions Gets or sets some memory and file transfer options that affect the acquisition process from the current WIA source.
Public Property FilesCount Gets the number of files saved when acquiring using File mode.
Public Property FilesPaths Gets a String collection that contains the saved file path(s) to be used when performing a file transfer.
Public Property SelectedDeviceType Gets the currently selected WIA device type.

Public Events

Name Description
Public Event AcquireEvent Occurs for each page acquired from the currently selected WIA source using the Acquire or AcquireSimple methods 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 WiaAcquireEventArgs event argument to indicate the end of each page transfer.
Public Event AcquireFileEvent 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.
Public Event EnumCapabilitiesEvent Occurs for each found capability of the currently selected WIA source after calling the EnumCapabilities method.
Public Event EnumDevicesEvent Occurs for each found WIA device after calling the EnumDevices method.
Public Event EnumFormatsEvent Occurs for each found supported transfer format of the currently selected WIA source after calling the EnumFormats method.
Public Event EnumItemsEvent Occurs for each found WIA child item after calling the EnumChildItems method.
Public Event SetPropertiesEvent Occurs while setting each property inside the WiaProperties structure after calling the SetProperties method.

Help Version 20.0.2019.9.19
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Wia Assembly