LAnnAutomation::SetEncryptOptions

#include "ltwrappr.h"

virtual L_INT LAnnAutomation::SetEncryptOptions(pEncryptOptions, uFlags)

pANNENCRYPTOPTIONS pEncryptOptions;	/* pointer to a structure that specifies various Encryption options */
L_UINT uFlags;	/* flags that determine which objects to process */

Sets the options for the specified Automation annotation object. This object may be in the encryptor or the decryptor state.

Parameter	Description
pEncryptOptions	Pointer to an ANNENCRYPTOPTIONS structure that specifies the various encryption options to set.
uFlags	Flags that determine which objects to process. Most of the flags apply only to container objects. You can combine values when appropriate by using a bitwise OR ( \| ). Possible values are:
	Value	Meaning
	0	Process only the specified object.
	ANNFLAG_SELECTED	[0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the LAnnotation::IsSelected and LAnnotation::SetSelected functions.
	ANNFLAG_NOTTHIS	[0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not.
	ANNFLAG_RECURSE	[0x0008] Process objects within a container, and within any subcontainers, down to any level.
	ANNFLAG_NOTCONTAINER	[0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves.
	ANNFLAG_NOINVALIDATE	[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.

Returns

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

Comments

Use this function to set the encrypt options of an Automation annotation object. To use this function, declare a variable of type ANNENCRYPTOPTIONS, and pass the address of this variable for pEncryptOptions.

Use the LAnnAutomation::GetEncryptOptions function to get the encrypt options of an Automation annotation object. These options are in an ANNENCRYPTOPTIONS structure.

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.

See Also

Functions:	Class Members
Topics:	Annotation Functions: Object Properties
	Implementing Annotations
	Automated User Interface for Annotations
	Annotation Functions: Creating and Deleting Annotations
	Types of Annotations
	Annotation Functions: Implementing Custom Annotations
	Annotation Functions: Creating Custom Annotations
	Fixed Annotations
	Minimizing Flicker With Double Buffering
	Annotation Functions: Working with the Toolbar

Example

L_INT LAnnAutomation_SetEncryptOptionsExample(LAnnAutomation *pLAuto) 
{
   L_INT nRet;
   L_BOOL bEncryptorOriginal; 
   ANNENCRYPTOPTIONS EncryptOptions; 
   L_UINT uObjectType; 
 
   uObjectType = pLAuto->GetType();
   if (uObjectType != ANNOBJECT_AUTOMATION) 
   {
      MessageBox(NULL, TEXT("This object is not an encryptor"), TEXT("Error"), MB_OK);
      return FAILURE;  
   }
   memset(&EncryptOptions, 0, sizeof(ANNENCRYPTOPTIONS)); 
   EncryptOptions.uStructSize = sizeof(ANNENCRYPTOPTIONS); 
   EncryptOptions.uFlags = ANNENCRYPT_ALL; 
   nRet = pLAuto->GetEncryptOptions(&EncryptOptions); 
   if(nRet != SUCCESS)
      return nRet;
 
   bEncryptorOriginal = EncryptOptions.bEncryptor; 
   // Set state to encryptor, and set encryptor metafile
   EncryptOptions.uFlags = ANNENCRYPT_TYPE; 
   EncryptOptions.bEncryptor = TRUE; 
   nRet = pLAuto->SetEncryptOptions(&EncryptOptions, 0); 
   if(nRet != SUCCESS)
      return nRet;
   // Set state to decryptor, and set decryptor metafile
   EncryptOptions.bEncryptor = FALSE; 
   nRet = pLAuto->SetEncryptOptions(&EncryptOptions, 0); 
   if(nRet != SUCCESS)
      return nRet;
   // Set encryptor  to oringal state
   EncryptOptions.bEncryptor = bEncryptorOriginal; 
   nRet = pLAuto->SetEncryptOptions(&EncryptOptions, 0); 
   if(nRet != SUCCESS)
      return nRet;
   return SUCCESS;
}