In This Topic ▼

LAnnAutomation::GetUndoDepth

Summary

Retrieves the number of user actions that can be reversed using the LAnnAutomation::Undo function.

Syntax

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::GetUndoDepth(puUsedLevels, puMaxLevels)

Parameters

L_UINT * puUsedLevels

Address of a variable to be updated with the number or user actions that can be reversed using LAnnAutomation::Undo. This number will be between 0 and the number retrieved in puMaxLevels.

L_UINT * puMaxLevels

Address of a variable to be updated with the maximum number of user actions that can be undone using LAnnAutomation::Undo. This is the value that was set using LAnnAutomation::SetUndoDepth.

Returns

Value	Meaning
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 LAnnAutomation::Undo 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.

Platforms

Win32, x64.

Example

This example uses the following member variables:
m_AnnotationWindow should be created and initialized prior to the example

L_INT LAnnAutomation_GetUndoDepthExample(LAnnotationWindow m_AnnotationWindow)  
{ 
   L_INT nRet; 
   L_UINT uUsedLevels, uMaxLevels; 
   L_TCHAR szMsg[100]; 
 
   nRet = m_AnnotationWindow.GetAutomationObject().GetUndoDepth(&uUsedLevels, &uMaxLevels); 
   if(nRet != SUCCESS) 
      return nRet; 
   wsprintf(szMsg,TEXT("UsedLevels[%d]\nMaxLevels[%d]"), uUsedLevels, uMaxLevels); 
   AfxMessageBox(szMsg); 
   return SUCCESS; 
}