LAnnAutomation::GetAutoUndoEnable
#include "ltwrappr.h"
virtual L_INT LAnnAutomation::GetAutoUndoEnable(pbEnable)
L_BOOL *pbEnable; |
/* pointer to a variable to be updated */ |
Retrieves the state of the undo mechanism for an automation object. This function is available in the Document/Medical Toolkits.
Parameter |
Description |
|
pbEnable |
Pointer to a variable to be updated with a value that indicates whether the undo mechanism for the automation object is enabled or disabled. Possible values are: |
|
|
Value |
Meaning |
|
TRUE |
The undo mechanism for this annotation object is enabled. |
|
FALSE |
Theundo mechanism for this annotation object is disabled. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
To enable or disable a particular automation object, call LAnnAutomation::SetAutoUndoEnable.
Required DLLs and Libraries
LTANN 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
Example
L_INT LAnnAutomation_GetAutoUndoEnableExample() { L_INT nRet = SUCCESS; LAnnAutomation lAutomation; L_BOOL IsEnabled = FALSE; nRet = lAutomation.GetAutoUndoEnable(&IsEnabled); if(nRet != SUCCESS) return nRet; if(!IsEnabled) nRet = lAutomation.SetAutoUndoEnable(TRUE); return nRet; }