L_WiaInitSession

Summary

Initializes the WIA session.

Syntax

L_LTWIA_API L_INT EXT_FUNCTION L_WiaInitSession(uWiaVersion, phSession)

Parameters

L_UINT uWiaVersion

The WIA version to be used. Possible values are:

pHWIASESSION phSession

Pointer to a WIA session handle. You should keep this handle handy since you are going to need it in almost all other WIA functions.

Returns

Comments

This feature is available in version 16 or higher.

L_WiaInitSession should be called before calling any other LEADTOOLS WIA toolkit function. Likewise, when the handle to the WIA session is no longer needed, it should be freed by calling L_WiaEndSession. For every call to L_WiaInitSession there must be a call to L_WiaEndSession.

Call the L_WiaIsAvailable function to determine whether a WIA source is installed, and which version of WIA is being used.

✎ NOTE

You do not need to call L_WiaInitSession if you are using the high-level L_WiaAcquireSimple function, since it handles session initialization, session end, and device selection automatically.

Required DLLs and Libraries

• LTWIA
• For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

LEADTOOLS WIA supports both 32-bit and 64-bit image acquisition for both WIA 1.0 (XP and earlier) and WIA 2.0 (VISTA and later).

See Also

Functions

• L_WiaEndSession

Topics

• Initializing a WIA Session
• Freeing the WIA Session
• Managing WIA Sources
• WIA Functionality: Session Functions

Example

For an example, refer to L_WiaIsAvailable.