Enables or disables the container.
#include "LtCon.h"
L_LTCON_API L_INT L_ContainerSetEnabled(pContainer, fEnable)
Pointer to a container handle.
Flag that indicates whether to enable or disable the container. Possible values are:
Value | Meaning |
---|---|
TRUE | enable the container. |
FALSE | disable the container. |
In order to edit objects in a container, the container must be enabled.
Value | Meaning |
---|---|
SUCCESS | The function was successful. |
< 1 | An error occurred. Refer to Return Codes. |
This example toggles the enabling state of the container.
L_INT ContainerSetEnabledExample(pCONTAINERHANDLE pContainer)
{
L_INT nRet;
L_BOOL fEnable ;
/* Get the enabling state of the container */
nRet = L_ContainerIsEnabled ( pContainer, &fEnable ) ;
if(nRet != SUCCESS)
return nRet;
/* Toggle the state and return */
return L_ContainerSetEnabled ( pContainer, ! fEnable ) ;
}