ItEv_GetControlTooltip 

Use

Returns the string of the tooltip associated with the specified control (the tooltip is the text the user sees when holding the mouse over an icon). It is mainly used for button controls that have an icon.

Syntax

DWORD DLEX ItEv_GetControlTooltip (PIT_EVENT pEvt, ITCCTRL pCtrl, char *Tip, int BuffLen, int *TipLen);

Parameters

pEvt

Pointer to the IT_EVENT structure to change

pCtrl

A string identifying the control to find. Refer to Specifying control

Tip

Buffer you allocate for the tooltip string. The maximum length of the tooltip string is 256.

BuffLen

Length of the memory buffer you have allocated in your program for the tooltip

TipLen

Length of the actual tooltip string. Allocated by the client program, and filled in by the call.

Return Value

Returns TRUE on success, FALSE on error.

If you allocate a buffer smaller than the size of the tooltip string, the function returns FALSE. However, in this case the function still returns the actual length of the tooltip in TipLen. You can use it to issue another call to this function with the correct buffer size allocated.