In This Topic ▼

L_DispContainerGetRulerAttributes

Summary

Gets the current attributes of the cell rulers.

#include "ltivw.h"

L_LTIVW_API L_INT L_DispContainerGetRulerAttributes(hCellWnd, pAttributes);

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

Pointer to a RULERATTRIBS structure to be updated with the current ruler attributes.

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

Before calling L_DispContainerGetRulerAttributes apply the following:

Declare a variable of type RULERATTRIBS.
Set RULERATTRIBS.uStructSize to sizeof(RULERATTRIBS).
Set RULERATTRIBS.uMask to indicate the properties to be updated with the current values.
Pass a pointer to the RULERATTRIBS structure to L_DispContainerGetRulerAttributes as the pAttributes parameter.

To set new cell properties, call L_DispContainerSetRulerAttributes.

For more information on the available attributes that can be used to control the shape of the ruler, refer to the RULERATTRIBS structure.