L_DispContainerLoadAnnotation

#include "l_bitmap.h"

L_LTIVW_API L_INT EXT_FUNCTION L_DispContainerLoadAnnotation(hCon, pFileName, nCellIndex, nSubCellIndex, nStartPage, uFlags)

HDISPCONTAINER hCon;

/* handle to the container */

LPTSTR pFileName;

/* name of the file to load */

L_INT nCellIndex;

/* index of the cell */

L_INT nSubCellIndex;

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

L_INT nStartPage;

/* page index to load */

L_UINT uFlags;

/* reserved for future */

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

Parameter

Description

hCon

Handle to the Container.

pFileName

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

nCellIndex

A zero-based index of the cell for which to load the annotation into. Pass -2 to load the annotation into the selected cell.

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.

nStartPage

The file page that loading the annotation will start from.

uFlags

Reserved for future use. Pass 0.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

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.