L_DispContainerDestroy

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerDestroy(hCon, bCleanImages, uFlags)

HDISPCONTAINER hCon;

/* handle to the container */

L_BOOL bCleanImages;

/* flag */

L_UINT uFlags;

/* reserved for future use */

Destroys the container and its cells.

Parameter

Description

hCon

Handle to the container.

bCleanImages

Flag that indicates whether to free the image(s) attached to each cell of the container. Possible values are:

 

Value

Meaning

 

TRUE

Free the image(s) attached to each cell.

 

FALSE

Do not free the image(s) attached to each cell.

uFlags

Reserved for future use. Pass 0.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

When the container created by L_DispContainerCreate is no longer needed, call this function to destroy the container and free the associated memory. For every call to L_DispContainerCreate there must be a call to L_DispContainerDestroy.

Required DLLs and Libraries

LTIVW

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_DispContainerCreate, L_DispContainerGetWindowHandle, L_DispContainerSetProperties L_DispContainerGetProperties, L_UseContainerControl, L_DispContainerGetHandle

Topics:

Using the Image Viewer

 

Image Viewer Functions: Using the Image Viewer

Example

For an example, refer to L_DispContainerCreate.