LAnnEncrypt::SetEncryptOptions

#include "ltwrappr.h"

virtual L_INT LAnnEncrypt::SetEncryptOptions(pEncryptOptions, uFlags)

pANNENCRYPTOPTIONS pEncryptOptions;

/* pointer to a structure that specifies various encrypt options */

L_UINT uFlags;

/* flags that determine which objects to process */

Sets the options for the specified Encrypt annotation object. This object may be in the encryptor or the decryptor state. This function is available in the Document/Medical Toolkits.

Parameter

Description

pEncryptOptions

Pointer to an ANNENCRYPTOPTIONS structure that specifies the various encrypt 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::SetSelectedfunctions.

 

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 encrypt annotation object. To use this function, declare a variable of type ANNENCRYPTOPTIONS, and pass the address of this variable for pEncryptOptions.

Use the LAnnEncrypt::GetEncryptOptions function to get the encrypt options of an encrypt 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.

See Also

Functions:

Class Members

Topics:

Annotation Functions: Object Properties

 

Implementing Annotations

 

Automated User Interface for Annotations

 

Annotation Functions: Creating and Deleting Annotations

Example

For an example, refer to LAnnEncrypt::GetSecondaryMetafile.