In This Topic ▼

L_AutRemoveContainer

Summary

Removes the specified container from the automation list of containers.

Syntax

#include "ltaut.h"

L_LTAUT_API L_INT L_AutRemoveContainer(pAutomation, pContainer)

Parameters

pAUTOMATIONHANDLE pAutomation

Pointer to an automation handle.

pCONTAINERHANDLE pContainer

Pointer to a container handle.

Returns

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

Comments

Removing the container from the automation list of containers will remove the automation functionality from that container and the window that owns it.

When working with vector automation, the user must free any vector handles associated with the automation container

Required DLLs and Libraries

LTAUT
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application

Example

This example shows how to remove some container from the automation.

L_INT AutRemoveContainerExample(pAUTOMATIONHANDLE  pAutomation, 
                                                pCONTAINERHANDLE   pContainer) 
{ 
   L_INT nRet; 
 
   nRet = L_AutIsValid ( pAutomation ) ; 
   if ( SUCCESS == nRet) /* check the validity of the automation handle */ 
   { 
      nRet = L_ContainerIsValid ( pContainer ) ; 
      if ( SUCCESS == nRet) /* check the validity of the container handle */ 
      { 
         /* Remove the container from the automation */ 
         nRet = L_AutRemoveContainer ( pAutomation, pContainer ) ; 
         if(nRet != SUCCESS) 
            return nRet; 
 
         /* Free the container handle */ 
         L_ContainerFree ( pContainer ) ; 
 
         return SUCCESS ; 
      } 
      else 
      { 
         return nRet ; 
      } 
   } 
   else 
   { 
      return nRet ; 
   } 
}