←Select platform
In This Topic ▼
WiaSession Class Members
Summary
The following tables list the members exposed by WiaSession.
Public Constructors
| Name | Description | |
|---|---|---|
 |
WiaSession | Constructs a new WiaSession object with default values. |
Public Methods
| Name | Description | |
|---|---|---|
 |
Acquire | Acquires one or more images from a WIA source. |
|
AcquireImageFromVideo | Extracts a still image from the video stream, and saves the image as a JPEG file. |
|
AcquireSimple | Acquires one or more images from a WIA source. |
|
AcquireToFile | Acquires one or more images from a WIA source directly to file(s). |
|
EndVideoPreview | Shuts down the streaming video. |
|
EnumCapabilities | Enumerates all of the available WIA driver capabilities and properties and determines the available values for each one. |
|
EnumChildItems | Enumerates all available child items for the root item specified in the parentItem parameter. |
|
EnumDevices | Enumerates all available system WIA devices connected to the user's machine. |
|
EnumFormats | Enumerates all of the available WIA driver transfer formats. |
|
FreeItem | Frees the items enumerated by the EnumChildItems method. |
 |
GetCategoryGuid | Retrieves the relevant System.Guid structure for the WIA 2.0 item's category. |
| |
GetFormatGuid | Retrieves the relevant System.Guid structure for the passed file format ID. |
|
GetProperties | Gets the properties for the specified item. |
|
GetPropertyBuffer | Retrieves the Stream buffer for any WiaVariableTypes.UI1 or WiaVariableTypes.Vector property. |
|
GetPropertyGuid | Retrieves the Guid structure for any WiaVariableTypes.Clsid property. |
| |
GetPropertyIdString | Gets the equivalent string for the passed property ID. |
|
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. |
|
GetPropertyString | Retrieves a string buffer for any WiaVariableTypes.Bstr property. |
|
GetPropertySystemTime | Retrieves a System.DateTime structure for any WiaVariableTypes.UI2 or WiaVariableTypes.Vector property. |
|
GetRootItem | Gets the equivalent string for the passed property ID. |
|
GetSelectedDevice | Gets a string that contains the ID for currently selected device. |
| |
IsAvailable | Determines which version of the WIA source is installed. |
|
IsVideoPreviewAvailable | Determines whether there is an available video preview. |
|
ResizeVideoPreview | Resizes the video playback to the largest supported resolution that fits inside the parent window. |
|
SelectDevice | Selects the WIA device represented by the passed device ID. |
|
SelectDeviceDlg | Displays a dialog box that enables the user to select a WIA hardware device for image acquisition. |
|
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. |
|
SetPropertyBuffer | Fills the Stream buffer for any WiaVariableTypes.UI1 or WiaVariableTypes.Vector property. |
|
SetPropertyGuid | Sets WiaVariableTypes.Clsid property values. |
|
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. |
|
SetPropertyString | Sets a string value for any WIA property of type WiaVariableTypes.Bstr that is not Read only. |
|
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. |
|
Shutdown | Ends a WIA session. |
|
Startup | Initializes the WIA session. |
|
StartVideoPreview | Starts the video preview inside the window handle specified through the owner parameter. |
Protected Methods
| Name | Description | |
|---|---|---|
 |
Dispose | This member supports the Leadtools infrastructure and is not intended to be used directly from your code. |
|
Finalize | This member overrides the System.Object.Finalize method. |
Public Properties
| Name | Description | |
|---|---|---|
 |
AcquireOptions | Gets or sets some memory and file transfer options that affect the acquisition process from the current WIA source. |
|
FilesCount | Gets the number of files saved when acquiring using File mode. |
|
FilesPaths | Gets a String collection that contains the saved file path(s) to be used when performing a file transfer. |
|
SelectedDeviceType | Gets the currently selected WIA device type. |
Public Events
| Name | Description | |
|---|---|---|
 |
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. |
|
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. |
|
EnumCapabilitiesEvent | Occurs for each found capability of the currently selected WIA source after calling the EnumCapabilities method. |
|
EnumDevicesEvent | Occurs for each found WIA device after calling the EnumDevices method. |
|
EnumFormatsEvent | Occurs for each found supported transfer format of the currently selected WIA source after calling the EnumFormats method. |
|
EnumItemsEvent | Occurs for each found WIA child item after calling the EnumChildItems method. |
|
SetPropertiesEvent | Occurs while setting each property inside the WiaProperties structure after calling the SetProperties method. |
