Leadtools.Wia Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
WiaSession Class Members
See Also  Properties  Methods  Events
Leadtools.Wia Namespace : WiaSession Class

The following tables list the members exposed by WiaSession.

Public Constructors

 NameDescription
Public Constructor WiaSession ConstructorConstructs a new WiaSession object with default values.  
Top

Public Properties

 NameDescription
Public Property AcquireOptions Gets or sets some memory and file transfer options that affect the acquisition process from the current WIA source.  
Public Property BufferValue Gets or sets the buffer value for a Stream type WIA .  
Public Propertystatic (Shared in Visual Basic) CategoryGuid Gets the relevant Guid value for the category Id passed as parameter for the WiaSession.GetCategoryGuid method.  
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) when performing a file transfer.  
Public Propertystatic (Shared in Visual Basic) FormatGuid Gets the relevant Guid value for the file format Id passed as a parameter for the GetFormatGuid method.  
Public Property GuidValue Gets or sets the WIA property value of type Guid.  
Public Property LongValue Gets or sets the WIA property long value.  
Public Property Properties Gets or sets common WIA source properties.  
Public Property RootItem Gets the WIA root item for the item passed through the GetRootItem method.  
Public Property SelectedDeviceType Gets the currently selected WIA device type.  
Public Property StringValue Gets or sets a String type WIA property value.  
Public Property SystemTimeValue Gets or sets a DateTime type WIA property value.  
Public Property TakenPictureFileName Gets the full path and filename of the captured JPEG file from the camera device.  
Top

Public Methods

 NameDescription
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 DisposeOverloaded.  This member supports the Leadtools infrastructure and is not intended to be used directly from your code.  
Public Method EndVideoPreview Shuts down the streaming video.  
Public Method EnumCapabilitiesyes  
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 Methodstatic (Shared in Visual Basic) GetCategoryGuid Retrieves the relevant Guid structure for the WIA 2.0 item's category.  
Public Methodstatic (Shared in Visual Basic) GetFormatGuid Retrieves the relevant Guid structure for the passed file format ID.  
Public Method GetProperties Gets the properties for the specified item.  
Public Method GetPropertyBuffer Retrieves the buffer of type Stream for any WIA property of type WiaVariableTypes.UI1 or WiaVariableTypes.Vector .  
Public Method GetPropertyGuid Retrieves the Guid structure for any WIA property of type WiaVariableTypes.Clsid .  
Public Methodstatic (Shared in Visual Basic) 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 WIA property of type WiaVariableTypes.Bstr.  
Public Method GetPropertySystemTime Retrieves a DateTime structure for any WIA property of type WiaVariableTypes.UI2 or WiaVariableTypes.Vector.  
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 Methodstatic (Shared in Visual Basic) IsAvailable Determines which version of the WIA source is installed.  
Public Method IsVideoPreviewAvailable Determines whether there is an available video preview.  
Public Method raise_AcquireEvent Occurs while acquiring from the WIA source.  
Public Method raise_AcquireFileEvent Occurs while acquiring to file from the WIA source.  
Public Method raise_EnumCapabilitiesEvent Occurs while enumerating the WIA capabilities of the selected WIA source.  
Public Method raise_EnumDevicesEvent Occurs while enumerating the WIA devices.  
Public Method raise_EnumFormatsEvent Occurs while enumerating the supported WIA transfer formats of the selected WIA source.  
Public Method raise_EnumItemsEvent Occurs while enumerating the WIA child items.  
Public Method raise_SetPropertiesEvent Occurs while setting the WIA properties.  
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 Fill the Stream buffer for any WIA property of type WiaVariableTypes.UI1 or WiaVariableTypes.Vector .  
Public Method SetPropertyGuid Sets properties values of type WiaVariableTypes.Clsid.  
Public Method SetPropertyLong Sets 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 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 as a form of DateTime structure for WIA property type WiaVariableTypes.UI2 or WiaVariableTypes.Vector.  
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.  
Top

Protected Methods

 NameDescription
Protected Method FinalizeOverridden.  This member overrides Finalize.  
Protected Method raise__acquireEvent Occurs while acquiring from the WIA source.  
Protected Method raise__acquireFileEvent Occurs while acquiring to file from the WIA source.  
Protected Method raise__enumCapabilitiesEvent Occurs while enumerating the WIA capabilities of the selected WIA source.  
Protected Method raise__enumDevicesEvent Occurs while enumerating the WIA devices.  
Protected Method raise__enumFormatsEvent Occurs while enumerating the supported WIA transfer formats of the selected WIA source.  
Protected Method raise__enumItemsEvent Occurs while enumerating the WIA child items.  
Protected Method raise__setPropertiesEvent Occurs while setting the WIA properties.  
Top

Public Events

 NameDescription
Public Event AcquireEvent Occurs for each page acquired from the currently selected WIA source using the Acquire or WiaSession.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 WiaSession.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 WiaSession.EnumCapabilities method.  
Public Event EnumDevicesEvent Occurs for each found WIA device after calling the WiaSession.EnumDevices method.  
Public Event EnumFormatsEvent Occurs for each found supported transfer format of the currently selected WIA source after calling the WiaSession.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.  
Top

See Also