In This Topic ▼

LAnnotation::GetRotateOptions

Summary

Gets the rotation options for the specified annotation object.

Syntax

#include "ltwrappr.h"

L_INT LAnnotation::GetRotateOptions(pRotateOptions, uStructSize)

Parameters

pANNROTATEOPTIONS pRotateOptions

Pointer to an ANNROTATEOPTIONS structure that specifies the rotate options to be set.

L_UINT uStructSize

Size in bytes, of the structure pointed to by pRotateOptions, for versioning. Use sizeof(ANNROTATEOPTIONS).

Returns

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

Comments

Use this function to get the rotation options of any annotation object, including the automation object. To use this function, declare a variable of type ANNROTATEOPTIONS, and pass the address of this variable as the second argument. For more information, refer to the documentation for the structure ANNROTATEOPTIONS.

This functionality can be enabled using the following code snippet:

L_VOID ExampleEnableOption(LAnnAutomation& annAutomation) 
{ 
   L_UINT nRet, uOptions = 0; 
   nRet = annAutomation.GetOptions(&uOptions); 
   nRet = annAutomation.SetOptions(uOptions | OPTIONS_NEW_ROTATE); 
}

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

L_INT LAnnotation_GetRotateOptionsExample(LAnnRectangle annrect) 
{ 
 
   // This example toggles whether the annotation object displays 
   // rotate handles. If displaying rotate handles, the object 
   // is changed so that it does not display rotate handles. 
   // If not displaying rotate handles, the object is changed 
   // so that it displays rotate handles 
 
   L_INT nRet; 
   L_TCHAR szMsg[200]; 
   ANNROTATEOPTIONS RotateOptions; 
 
   memset(&RotateOptions, 0, sizeof(ANNROTATEOPTIONS)); 
 
   RotateOptions.uStructSize = sizeof(ANNROTATEOPTIONS); 
   RotateOptions.uFlags = ANNROTATE_SHOW_ROTATE_HANDLES; 
   RotateOptions.nReserved = 0; 
 
   nRet = annrect.GetRotateOptions(&RotateOptions, sizeof(ANNROTATEOPTIONS)); 
   if (nRet != SUCCESS) 
      return  nRet; 
 
   wsprintf(szMsg, TEXT("Old State: bShowRotateHandles: %s"), RotateOptions.bShowRotateHandles ? TEXT("TRUE") :  
            TEXT("FALSE")); 
 
   MessageBox(NULL, szMsg, TEXT(""), MB_OK); 
 
   // Change the state 
 
   RotateOptions.bShowRotateHandles = !RotateOptions.bShowRotateHandles; 
 
   nRet = annrect.SetRotateOptions(&RotateOptions, 0); 
   if (nRet != SUCCESS) 
      return nRet; 
 
   nRet = annrect.GetRotateOptions(&RotateOptions, sizeof(ANNROTATEOPTIONS)); 
   if (nRet != SUCCESS) 
      return  nRet; 
 
   wsprintf(szMsg, TEXT("New State: bShowRotateHandles: %s"),  
            RotateOptions.bShowRotateHandles ? TEXT("TRUE") :  
            TEXT("FALSE")); 
 
   MessageBox(NULL, szMsg, TEXT(""), MB_OK); 
 
   return SUCCESS; 
}