LWIAENUMDEVICESCALLBACK

#include "ltwia.h"

L_INT pEXT_CALLBACK YourFunction(hSession, pDeviceID, pUserData)

HWIASESSION hSession;

/* handle to an existing WIA session */

pLWIADEVICEID pDeviceID;

/* pointer to a structure that contains information about found device */

L_VOID * pUserData;

/* pointer to additional parameters */

Called for each WIA device found connected to the user machine. The address of this callback is passed as an argument in L_WiaEnumDevices.

Parameter

Description

hSession

Handle to an existing WIA session. This handle is obtained by calling the L_WiaInitSession function.

pDeviceID

Pointer to a structure that contains information about each device found on the user machine.

pUserData

A void pointer that you can use to access a variable or structure containing data that your callback function needs. This gives you a way to receive data indirectly from the function that uses this callback function. (This is the same pointer that you pass in the pUserData parameter of L_WiaEnumDevices.)

 

Keep in mind that this is a void pointer, which must be cast to the appropriate data type within your callback function.

Returns

SUCCESS

The function was successful.

ERROR_USER_ABORT

The callback wants to abort the device enumeration process.

< 1

An error occurred. Refer to Return Codes.

Comments

This feature is available in version 16 or higher.

Called for each WIA device found connected to the user machine. Provides information about the found WIA device like Device ID, Device Name and Device Description.

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.

See Also

Functions:

L_WiaEnumDevices, L_WiaInitSession, L_WiaEndSession.

Topics:

Managing WIA Sources

 

WIA Functionality: Property Functions

 

WIA Functionality: Callbacks

Example

For an example, refer to L_WiaEnumDevices.