LEADTOOLS WIA (Leadtools.Wia assembly)
LEAD Technologies, Inc

WiaSession Class

Properties  Methods  Events


The following tables list the members exposed by WiaSession.

Public Constructors
 NameDescription
Public ConstructorWiaSession Constructor

Constructs a new WiaSession object with default values.

 
Top
Public Properties
 NameDescription
Public PropertyAcquireOptionsGets or sets some memory and file transfer options that affect the acquisition process from the current WIA source.  
Public PropertyFilesCountGets the number of files saved when acquiring using File mode.  
Public PropertyFilesPathsGets a String collection that contains the saved file path(s) when performing a file transfer.  
Public PropertySelectedDeviceTypeGets the currently selected WIA device type.  
Top
Public Methods
 NameDescription
Public MethodAcquireAcquires one or more images from a WIA source.  
Public MethodAcquireImageFromVideoExtracts a still image from the video stream, and saves the image as a JPEG file.  
Public MethodAcquireSimpleAcquires one or more images from a WIA source.  
Public MethodAcquireToFileAcquires one or more images from a WIA source directly to file(s).  
Public MethodDisposeOverloaded. This member supports the Leadtools infrastructure and is not intended to be used directly from your code.  
Public MethodEndVideoPreviewShuts down the streaming video.  
Public MethodEnumCapabilitiesEnumerates all of the available WIA driver capabilities and properties and determines the available values for each one.  
Public MethodEnumChildItemsEnumerates all available child items for the root item specified in the parentItem parameter.  
Public MethodEnumDevicesEnumerates all available system WIA devices connected to the user's machine.  
Public MethodEnumFormatsEnumerates all of the available WIA driver transfer formats.  
Public MethodFreeItemFrees the items enumerated by the EnumChildItems method.  
Public Methodstatic (Shared in Visual Basic)GetCategoryGuidRetrieves the relevant System.Guid structure for the WIA 2.0 item's category.  
Public Methodstatic (Shared in Visual Basic)GetFormatGuidRetrieves the relevant System.Guid structure for the passed file format ID.  
Public MethodGetPropertiesGets the properties for the specified item.  
Public MethodGetPropertyBufferRetrieves the buffer of type Stream for any WIA property of type WiaVariableTypes.UI1 or WiaVariableTypes.Vector .  
Public MethodGetPropertyGuidRetrieves the Guid structure for any WIA property of type WiaVariableTypes.Clsid .  
Public Methodstatic (Shared in Visual Basic)GetPropertyIdStringGets the equivalent string for the passed property ID.  
Public MethodGetPropertyLongRetrieves 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 MethodGetPropertyStringRetrieves a string buffer for any WIA property of type WiaVariableTypes.Bstr.  
Public MethodGetPropertySystemTimeRetrieves a System.DateTime structure for any WIA property of type WiaVariableTypes.UI2 or WiaVariableTypes.Vector.  
Public MethodGetRootItemGets the equivalent string for the passed property ID.  
Public MethodGetSelectedDeviceGets a string that contains the ID for currently selected device.  
Public Methodstatic (Shared in Visual Basic)IsAvailableDetermines which version of the WIA source is installed.  
Public MethodIsVideoPreviewAvailableDetermines whether there is an available video preview.  
Public Methodraise_AcquireEventOccurs while acquiring from the WIA source.  
Public Methodraise_AcquireFileEventOccurs while acquiring to file from the WIA source.  
Public Methodraise_EnumCapabilitiesEventOccurs while enumerating the WIA capabilities of the selected WIA source.  
Public Methodraise_EnumDevicesEventOccurs while enumerating the WIA devices.  
Public Methodraise_EnumFormatsEventOccurs while enumerating the supported WIA transfer formats of the selected WIA source.  
Public Methodraise_EnumItemsEventOccurs while enumerating the WIA child items.  
Public Methodraise_SetPropertiesEventOccurs while setting the WIA properties.  
Public MethodResizeVideoPreviewResizes the video playback to the largest supported resolution that fits inside the parent window.  
Public MethodSelectDeviceSelects the WIA device represented by the passed device ID.  
Public MethodSelectDeviceDlgDisplays a dialog box that enables the user to select a WIA hardware device for image acquisition.  
Public MethodSetPropertiesSets 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 MethodSetPropertyBufferFill the Stream buffer for any WIA property of type WiaVariableTypes.UI1 or WiaVariableTypes.Vector .  
Public MethodSetPropertyGuidSets properties values of type WiaVariableTypes.Clsid.  
Public MethodSetPropertyLongSets the Long value for any WIA property of type: WiaVariableTypes.I1, WiaVariableTypes.UI1, WiaVariableTypes.I2, WiaVariableTypes.UI2, WiaVariableTypes.I4, WiaVariableTypes.UI4, WiaVariableTypes.Int, WiaVariableTypes.UInt, WiaVariableTypes.R4 and WiaVariableTypes.R8.  
Public MethodSetPropertyStringSets a string value for any WIA property of type WiaVariableTypes.Bstr that is not Read only.  
Public MethodSetPropertySystemTimeSets the date and time of the specified item as a form of System.DateTime structure for WIA property type WiaVariableTypes.UI2 or WiaVariableTypes.Vector.  
Public MethodShutdownEnds a WIA session.  
Public MethodStartupInitializes the WIA session.  
Public MethodStartVideoPreviewStarts the video preview inside the window handle specified through the owner parameter.  
Top
Protected Methods
 NameDescription
Protected MethodFinalizeThis member overrides System.Object.Finalize.  
Protected Methodraise__acquireEventOccurs while acquiring from the WIA source.  
Protected Methodraise__acquireFileEventOccurs while acquiring to file from the WIA source.  
Protected Methodraise__enumCapabilitiesEventOccurs while enumerating the WIA capabilities of the selected WIA source.  
Protected Methodraise__enumDevicesEventOccurs while enumerating the WIA devices.  
Protected Methodraise__enumFormatsEventOccurs while enumerating the supported WIA transfer formats of the selected WIA source.  
Protected Methodraise__enumItemsEventOccurs while enumerating the WIA child items.  
Protected Methodraise__setPropertiesEventOccurs while setting the WIA properties.  
Top
Public Events
 NameDescription
Public EventAcquireEventOccurs 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 EventAcquireFileEventOccurs 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 EventEnumCapabilitiesEventOccurs for each found capability of the currently selected WIA source after calling the EnumCapabilities method.  
Public EventEnumDevicesEventOccurs for each found WIA device after calling the EnumDevices method.  
Public EventEnumFormatsEventOccurs for each found supported transfer format of the currently selected WIA source after calling the EnumFormats method.  
Public EventEnumItemsEventOccurs for each found WIA child item after calling the EnumChildItems method.  
Public EventSetPropertiesEventOccurs while setting each property inside the WiaProperties structure after calling the SetProperties method.  
Top
See Also

Reference

WiaSession Class
Leadtools.Wia Namespace

 

 


Products | Support | Contact Us | Copyright Notices

© 2006-2012 All Rights Reserved. LEAD Technologies, Inc.