L_AnnGetUndoDepth
#include "l_bitmap.h"
L_LTANN_API L_INT L_AnnGetUndoDepth(hObject, puUsedLevels, puMaxLevels)
HANNOBJECT hObject; |
/* handle to the automation object */ |
L_UINT *puUsedLevels; |
/* address of a variable to be updated */ |
L_UINT *puMaxLevels; |
/* address of a variable to be updated */ |
Retrieves the number of user actions that can be reversed using the L_AnnUndo function.
Parameter |
Description |
hObject |
Handle to the automation object. |
puUsedLevels |
Address of a variable to be updated with the number or user actions that can be reversed using L_AnnUndo. This number will be between 0 and the number retrieved in puMaxLevels. |
puMaxLevels |
Address of a variable to be updated with the maximum number of user actions that can be undone using L_AnnUndo. This is the value that was set using L_AnnSetUndoDepth. |
Returns
SUCCESS |
The function was successful. |
< 1 |
An error occurred. Refer to Return Codes. |
Comments
If puUsedLevels is updated with a value of 0, no user actions can be undone using the L_AnnUndo function.
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. |
Win32, x64.
See Also
Functions: |
|
Topics: |
|
|
|
|
|
|
|
|
Example
For an example, refer to L_AnnUndo.