L_DispContainerLoadRegion

#include "l_bitmap.h"

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

HWND hCellWnd;

/* handle to the cell window */

LPTSTR pFileName;

/* name of the file to load */

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 region file into the specified cell or sub-cell.

Parameter

Description

hCellWnd

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

pFileName

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

nSubCellIndex

A zero-based index into the image list attached to the cell specified in nCellIndex. This sub-cell contains the image that the region 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 region page saved by the function L_DispContainerSaveRegion.

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_DispContainerSaveRegion, L_DispContainerAnnToRgn, L_DispContainerSetRegionCallBack, L_DispContainerGetRegionCallBack, DISPCONTAINERREGIONCALLBACK

Topics:

Image Viewer Cells

 

Image Viewer Functions: Image Viewer Cells

 

Creating a Bitmap Region Inside the Image Viewer

Example

For an example, refer to L_DispContainerSaveRegion.