L_DispContainerGetCellScale

#include "l_bitmap.h"

L_LTIVW_API L_INT EXT_FUNCTION L_DispContainerGetCellScale(hCon, nCellIndex, nSubCellIndex, pdScale, uFlags)

HDISPCONTAINER hCon;	/* handle to the container */
L_INT nCellIndex;	/* index of a cell */
L_INT nSubCellIndex;	/* index into the image list attached to the cell */
L_DOUBLE * pdScale;	/* pointer to a variable to be updated */
L_UINT uFlags;	/* reserved for future use */

Gets the current scale value of the speifcied cell or sub-cell.

Parameter	Description
hCon	Handle to the container.
nCellIndex	A zero-based index of the cell that contains the sub-cell, which is having its scale value obtained.
nSubCellIndex	A zero-based index into the image list attached to the cell specified in nCellIndex. The scale for this sub-cell will be retrieved. This sub-cell scale will be retrieved. Pass -2 to retrieve the scale of the selected sub-cell.
pdScale	Address of the variable to be updated with the scale value.
uFlags	Reserved for future use. Pass 0.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

Currently, there are two ways to fit an image to a cell. One is by setting the bIsFit value of the DISPCELLPROPERTIES structure to true (also remembering to set the corresponding uMask value), and then send this structure to the function L_DispContainerSetCellProperties. The other method is by using the L_DispContainerGetCellScale and L_DispContainerSetCellScale functions. If using these make sure that bIsFit is set to FALSE.

To set the scale of a cell or sub-cell call L_DispContainerSetCellScale, and to set the properties of the scale action use the L_DispContainerSetActionProperties function. To retrieve the properties of the scale action use the L_DispContainerGetActionProperties function. To set the scale mode of a cell or sub-cell call the L_DispContainerSetCellScaleMode function and to get it call L_DispContainerGetCellScaleMode.

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.

Platforms

Windows 2000 /XP/Vista.

See Also

Functions:	L_DispContainerGetCellScaleMode, L_DispContainerSetCellScaleMode, L_DispContainerSetCellScale, L_DispContainerCreate, L_DispContainerRemoveCell, L_DispContainerInsertCell, L_DispContainerGetCellCount, L_DispContainerGetCellWindowHandle, L_DispContainerSetCellTag, L_DispContainerSetCellProperties, L_DispContainerAddAction, L_DispContainerSetAction, L_DispContainerGetActionProperties, L_DispContainerRemoveAction, L_DispContainerGetActionCount
Topics:	Applying Actions
	Image Viewer Functions: Applying Actions

Example

For an example, refer to L_DispContainerBeginUpdate.