L_TwainLockContainer

#include "lttw2.h"

L_INT EXT_FUNCTION L_TwainLockContainer(pCapability, ppContainer)

TW_CAPABILITY * pCapability;	/* pointer to a structure */
L_VOID ** ppContainer;	/* pointer to a pointer to a structure */

Gets the container information for the specified capability.

Parameter	Description
pCapability	Pointer to a TW_CAPABILITY structure from which to get the container.
ppContainer	Pointer to be updated with a pointer to the container.

Returns

SUCCESS	The function was successful.
! = SUCCESS	An error occurred. Refer to Return Codes.

Comments

This function is used to lock the container present in the TW_CAPABILITY structure.

Once the user has the pointer to the container, the container may be changed. When the user has finished changing the container he or she must call L_TwainUnlockContainer to unlock the container. Note that this can also be accomplished using the API GlobalLock and GlobalUnlock functions.

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_TwainUnlockContainer.
Topics:	How to Work with the Containers
	TWAIN Functionality: Container Functions.

Example

TW_CAPABILITY twCap;
TW_ONEVALUE * ptwOneVal = NULL;

if (twCap.ConType == TWON_ONEVALUE)
{
   L_TwainLockContainer (&twCap, (void **)&ptwOneVal);
   if (ptwOneVal)
   {
      // Do processing
      L_TwainUnlockContainer (&twCap);
   }
}