VisuFctGetMeasureString2Result (FUN)

FUNCTION VisuFctGetMeasureString2Result : BOOL

This function is used to retrieve the result of a previous call to MeasureString2. Normally this function is called from the HandleInput method of a visu element.

InOut:

Scope

Name

Type

Comment

Return

VisuFctGetMeasureString2Result

BOOL

TRUE if the result was returned successfully.

Input

pCurrentClientData

POINTER TO VisuStructClientData

Points to the current client data.

pEvent

POINTER TO VisuStructEvent

Points to the event, that was passed to method HandleInput

diMeasureStringID

DINT

Identifies the request to measure the string. Pass here the return value of method MeasureString2.

paiHeightAndWidths

POINTER TO ARRAY [0..0] OF INT

Points to an array of INT values, where the result of the string measuring will be stored. For a string of length N the positions 0 … N - 1 will be used to store the widths of the beginning substrings. The value at index N will be used to store the height of the measured string.

iEffectiveArraySize

INT

The effective number of elements of the array above. Normally here will be passed N + 1 (if the length of the measured string is N)