L_ContainerSetEnabled
#include "LtCon.h"
L_LTCON_API L_INT L_ContainerSetEnabled(pContainer, fEnable)
pCONTAINERHANDLE pContainer; |
/* pointer to a container handle */ |
L_BOOL fEnable; |
/* enable/disable flag */ |
Enables or disables the container.
Parameter |
Description |
|
pContainer |
Pointer to a container handle. |
|
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
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
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: |
|
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 ) ; }