L_ContainerReset

#include "LtCon.h"

L_LTCON_API L_INT L_ContainerReset(pContainer)

pCONTAINERHANDLE pContainer;

/* pointer to a container handle */

Erases the contents of the container from the screen.

Parameter

Description

pContainer

Pointer to a container handle.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function erases the contents of the container from the screen drawing, but it does not reset the actual container data.

Required DLLs and Libraries

LTCON

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_ContainerUpdate

Topics:

Displaying Objects

Example

This example will reset the container drawing contents. 

 L_INT ContainerResetExample(pCONTAINERHANDLE pContainer)
{
   L_INT nRet;

   nRet = L_ContainerIsValid ( pContainer );
   if (SUCCESS == nRet ) /* check the validity of container handle */
   {
      /* Reset the container drawing on the screen (if any) */
      nRet = L_ContainerReset ( pContainer ) ;
   }
   return nRet;
}