Collapse All Expand All

LTwain::UnlockContainer

#include "ltwrappr.h"

virtual L_INT LTwain::UnlockContainer (pCapability)

TW_CAPABILITY * pCapability;

/* pointer to a structure */

Sets the container information of the specified capability.

Parameter	Description
pCapability	Pointer to a TW_CAPABILITY structure that contains the information to set.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This function is used to unlock the container present in the TW_CAPABILITY stucture.

To access the container so that it may be modified, call LTwain::LockContainer. This function provides the user with a pointer to the container. At this point the container may be changed. When the user has finished changing the container he or she must call LTwain::UnlockContainer to unlock the container. Note that this can also be accomplished using the C DLL 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:	LTwain::LockContainer.
Topics:	How to Work with the Containers
	TWAIN Functionality: Container Functions.

Example

For an example, refer to LTwain::LockContainer.