L_WiaInitSession

#include "ltwia.h"

L_LTWIA_API L_INT EXT_FUNCTION L_WiaInitSession(uWiaVersion, phSession)

L_UINT uWiaVersion;

/* WIA version you wish to use */

pHWIASESSION phSession;

/* pointer to a WIA session handle */

Initializes the WIA session.

Parameter

Description

uWiaVersion

The WIA version to be used. Possible values are:

 

Value

Meaning

 

WiaVersion1

[1] Use WIA version 1.

 

WiaVersion2

[2] Use WIA version 2.

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

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

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

Earlier and later operating systems than Windows XP for WIA Version 1.

Windows VISTA or later for WIA Version 2.

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.