L_DispContainerGetSelectedAnnotationAttributes

Summary

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

Syntax

L_LTIVW_API L_INT L_DispContainerGetSelectedAnnotationAttributes(hCellWnd, nSubCellIndex, pAnnAttributes,uFlags)

Parameters

L_HWND hCellWnd

A handle to the window that represents the cell on which the function's effect will be applied.

L_INT nSubCellIndex

A zero-based index into the image list attached to the cell specified in nCellIndex. This image contains the annotation object the user wants to retrieve its attributes. Pass -2 to retrieve the selected annotation attributes of the selected sub-cell.

pDISPCONTAINERANNATTRIBS pAnnAttributes

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

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

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

• L_DispContainerCreate
• L_DispContainerDestroy
• L_DispContainerSetAction
• L_DispContainerAddAction
• L_DispContainerAnnToRgn.

Topics

• Working with Annotations
• Image Viewer Functions: Working with Annotations

Example

For an example, refer to L_DispContainerAnnToRgn