L_DispContainerLoadAnnotation

Summary

Loads the annotation file into the specified cell or sub-cell.

Syntax

L_LTIVW_API L_INT EXT_FUNCTION L_DispContainerLoadAnnotation(hCellWnd, pFileName, nSubCellIndex, nStartPage, uFlags)

Parameters

L_HWND hCellWnd

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

LPTSTR pFileName

Character string that contains the name of the file to load.

L_INT nSubCellIndex

A zero-based index into the image list attached to the cell specified in I. This sub-cell contains the image that the annotation will be loaded into. Pass -2 to refer to the selected sub-cell. If the cell contains 1 frame then the nSubCellIndex should be 0.

L_INT nStartPage

The file page that loading the annotation will start from.

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

Comments

This function loads the annotation page saved by the function L_DispContainerSaveAnnotation.

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_DispContainerSetAnnotationContainer
• L_DispContainerAnnToRgn
• L_DispContainerGetSelectedAnnotationAttributes
• L_DispContainerSetAnnotationCallBack
• L_DispContainerGetAnnotationCallBack
• L_DispContainerGetAnnotationContainer
• L_DispContainerSetAnnotationCreatedCallBack
• L_DispContainerSaveAnnotation
• DISPCONTAINERANNOTATIONCALLBACK
• DISPCONTAINERANNOTATIONCREATEDCALLBACK

Topics

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

Example

For an example, refer to L_DispContainerSaveAnnotation.