LTwain::CapabilityCallBack

#include "ltwrappr.h"

virtual L_INT LTwain:: CapabilityCallBack (uCap, pCapability)

L_UINT uCap;

/* capability received */

pTW_CAPABILITY * pCapability;

/* pointer to a structure */

Handles each capability enumerated by the LTwain::EnumCapabilities function.

Parameter

Description

uCap

The capability being enumerated. For more information on capability values, refer to the Twain 1.9 Specification, available at www.twain.org.

pCapability

Pointer to the TW_CAPABILITY structure that references the capability data being enumerated. For more information about TW_CAPABILITY, refer to the TWAIN 1.9 specification from the site http://www.twain.org/.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This callback function will be enabled only if you enabled the callback functions by calling LBase::EnableCallBack(TRUE).

To prevent memory leaks, the user should free the pointer to TW_CAPABILITY structure within the callback function.

This structure can be freed by a call to LTwain::FreeContainer then you can free the pointer using GlobalFreePtr macro defined in Windows.h.

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:

LTwain::EnumCapabilities.

Topics:

TWAIN Functionality: Callback Functions.

Example

For an example, refer to LTwain::AddCapabilityToFile.