LImageViewerCell::GetSelectedAnnotationAttributes

#include "ltwrappr.h"

L_INT LImageViewerCell::GetSelectedAnnotationAttributes(nSubCellIndex, pAnnAttributes, uFlags)

L_INT nSubCellIndex;

/* index into the image list attached to the cell */

pDISPCONTAINERANNATTRIBS pAnnAttributes;

/* pointer to the annotation attributes structure */

L_UINT uFlags;

/* reserved for future use */

Retrieves the attributes of the selected annotation object of the specified sub-cell, if any.

Parameter

Description

nSubCellIndex

A zero-based index into the image list attached to the cell. This image contains the annotation object for which the user wishes to retrieve attributes. Pass -2 to retrieve the selected annotation attributes of the selected sub-cell.

pAnnAttributes

Pointer to a DISPCONTAINERANNATTRIBS structure to be updated with the selected annotation attributes.

uFlags

Reserved for future use. Pass 0.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function returns ERROR_INV_PARAMTER if there is no selected annotation in the specific sub-cell.

Required DLLs and Libraries

LTIVW

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:

LImageViewer::Create, LImageViewer::Destroy, LImageViewerCell::SetAction, LImageViewerCell::AddAction, LImageViewerCell::AnnToRgn.

Topics:

The Annotation Feature

 

Image Viewer Functions: The Annotation Feature

Example

For an example, refer to LImageViewerCell::AnnToRgn.