LTWAINSAVEERRORCALLBACK Function

#include "lttwn.h"

L_INT pEXT_CALLBACK YourFunction (hSession, pCapability, uError, pUserData)

HTWAINSESSION hSession;

handle to an existing TWAIN session

pTW_CAPABILITY pCapability;

pointer to a structure

L_UINT uError;

error code

L_VOID * pUserData;

pointer to additional parameters

Called when an error occurs while saving capability data supported by a particular TWAIN source to a specific template file. The address of this callback is passed as an argument in L_TwainTemplateDlg.

Parameter

Description

hSession

Handle to an existing TWAIN session. This handle is obtained by calling the L_TwainInitSession or L_TwainInitSession2 function.

pCapability

Pointer to the TW_CAPABILITY structure that references the capability data that was being saved to a specific template file when the error occurred. For more information about TW_CAPABILITY, refer to the TWAIN 1.9 specification from the site http://www.twain.org/.

uError

Error code.

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_TwainTemplateDlg.)

 

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.

SUCCESS_RETRY

Retry saving the capability value.

SUCCESS_ABORT

Abort the saving procedure.

SUCCESS_DELETE

Abort saving procedure and delete the file.

Comments

The user should not free the pointer to the TW_CAPABILITY structure within this callback.

Required DLLs and Libraries

LTTWN

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_TwainTemplateDlg.

Topics:

TWAIN Functionality: Callback Functions.

Example

For an example, refer to L_TwainTemplateDlg.

Products | Support | Contact Us | Copyright Notices
© 1991-2017 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS TWAIN C API Help
Click or drag to resize