In This Topic ▼

L_DispContainerGetCellTag

Summary

Retrieves the cell tag information.

Syntax

#include "ltivw.h"

L_LTIVW_API L_INT EXT_FUNCTION L_DispContainerGetCellTag(hCellWnd, uRow, uAlign, pTagInfo, uFlags)

Parameters

L_HWND hCellWnd

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

L_UINT uRow

The number of rows to count before reaching the Sub-cell tag to be retrieved.

L_UINT uAlign

Value that specifies the origin point from which to count the rows specified in the uRow parameter. For example, if uAlign is DISPWIN_ALIGN_BOTTOMLEFT and uRow is 4, the application will count 4 rows from the bottom and place the tag on that location. Possible values are:

Value	Meaning
DISPWIN_ALIGN_TOPLEFT	[0x0000] Start counting rows from the top of the cell. The tag will be left justified.
DISPWIN_ALIGN_LEFTCENTER	[0x0001] The tag is placed in the center, based on the height of the cell, and is left justified.
DISPWIN_ALIGN_BOTTOMLEFT	[0x0002] Start counting rows from the bottom of the cell. The tag will be left justified.
DISPWIN_ALIGN_TOPCENTER	[0x0003] The tag is placed in the center, based on the width of the cell, and is top justified.
DISPWIN_ALIGN_BOTTOMCENTER	[0x0004] The tag is placed in the center, based on the width of the cell, and is bottom justified.
DISPWIN_ALIGN_TOPRIGHT	[0x0005] Start counting rows from the top of the cell. The tag will be right justified.
DISPWIN_ALIGN_RIGHTCENTER	[0x0006] The tag is placed in the center, based on the height of the cell, and is right justified.
DISPWIN_ALIGN_BOTTOMRIGHT	[0x0007] Start counting rows from the bottom of the cell. The tag will be right justified.

DISPCELLTAGINFO * pTagInfo

Pointer to a DISPCELLTAGINFO structure that provides information about the tag specified using the uRow and uAlign parameters.

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

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

Comments

If you are planning to retrieves the text, be sure to allocate enough space to hold the tag text.

This function retrieves the Cell tag. The cell tag is the tag that appears on all the frames in the cell. You can create a cell tag using the function L_DispContainerSetCellTag. To create a tag that appears only on the desired frame, use L_DispContainerSetSubCellTag.