L_ContainerSetEnabled

#include "LtCon.h"

L_LTCON_API L_INT L_ContainerSetEnabled(pContainer, fEnable)

Enables or disables the container.

Parameters

pCONTAINERHANDLE pContainer

Pointer to a container handle.

L_BOOL fEnable

Flag that indicates whether to enable or disable the container. Possible values are:

Value Meaning
TRUE enable the container.
FALSE disable the container.

Comments

In order to edit objects in a container, the container must be enabled.

Returns

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

Required DLLs and Libraries

See Also

Functions

Topics

Example

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 ) ; 
} 

Help Version 21.0.2020.8.24
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Container and Automation C API Help