Syntax

SetMicroHelp(<window>,<string>)

where:<window> is the name of the MDI frame window with micro help for which you want to set the MicroHelp. 

<string> is a string containing the text of the new MicroHelp (the tag value for the control).

Result

Sets the MicroHelp text in window to string. 

Returns 1 if it succeeds and -1 if an error occurs.

Use

In the script for a MenuItem's Selected event, to change the MicroHelp associated with the MenuItem.

Return Data Type

Integer.

Examples:

This statement changes the MicroHelp in W_New to Delete selected text:

SetMicroHelp(W_New,"Delete selected text")

If the string Close the Window is a tag value associated with the CommandButton cb_done in W_New, this statement in the script for the GetFocus event in cb_done displays the MicroHelp in W_New to Close the Window when cb_done gets focus:

SetMicroHelp(W_New,this.tag)