LAutomation::SetActiveContainer

#include "ltwrappr.h"

L_INT LAutomation::SetActiveContainer(pLContainer )

LContainer * pLContainer;

/* pointer to an LContainer object */

Sets the active automation container.

Parameter

Description

pLContainer

Pointer to the LContainer object that references the container to be activated.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

The container being set must exist in the automation container list. To add a container to the automation container list, call LAutomation::AddContainer.

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

See Also

Functions:

LAutomation::GetActiveContainer, LAutomation::AddContainer

Topics:

Automation and the Container

Example

This example shows how to set the automation active container.

L_INT LAutomation_SetActiveContainerExample(LContainer &lcon,LAutomation &lauto)
{
   L_INT nRet;
   nRet = lauto.IsValid ();
   if ( SUCCESS == nRet ) /* check the validity of the automation handle */
   {
      nRet = lcon.IsValid ();
      if ( SUCCESS == nRet ) /* check the validity of the container handle */
      {
         LContainer *pActiveContainer ;
         /* get the current active container */
         pActiveContainer = lauto.GetActiveContainer() ;
         if ( &lcon != pActiveContainer ) /* if the new container is not currently active */
         {
            /* set the new active container */
            nRet = lauto.SetActiveContainer (&lcon) ;
            if(nRet != SUCCESS)
               return nRet;
         }
      }
      else
      {
         return nRet ;
      }
   }
   else
   {
      return nRet ;
   }
   return SUCCESS;
}