LAnnotation::GetNameOptions

#include "l_bitmap.h"

virtual L_INT LAnnotation::GetNameOptions(pNameOptions, uStructSize)

pANNNAMEOPTIONS pNameOptions;

/* pointer to a structure that specifies the name options */

L_UINT uStructSize;

/* size in bytes, of the structure pointed to by pNameOptions, for versioning. Use sizeof(ANNNAMEOPTIONS). */

Gets the name options for the specified annotation object. This function is available in the Document/Medical Toolkits.

Parameter

Description

pNameOptions

Pointer to an ANNNAMEOPTIONS structure to be updated with the name options.

uStructSize

Size in bytes, of the structure pointed to by pNameOptions. Use sizeof(ANNNAMEOPTIONS).

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

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

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:

LAnnotation::SetNameOptions

Topics:

Annotation Functions: Object Properties

 

Annotation Objects - Default Values

 

Annotation Objects - Automated Features

Example

For an example, refer to LAnnotation::SetNameOptions.