Show_Button

Functions

void Show_Button (char *button)
 Returns the name of the button that initiated the current event. More...
 

Detailed Description

Function Documentation

◆ Show_Button()

void Show_Button ( char *  button)

Returns the name of the button that initiated the current event.

Parameters
button- The button name. Often, a single character. Passed by reference always. Returned to user.

DETAILS

Once a "button" event has reached the front of the event queue and become the current event—either by enabling button events and then calling Await_Event() , or by calling Get_Button() to do all the work—your program can ask for details about it.

The simplest detail of a button event is the name of the button. The button name is returned in the same format as it was originally specified in Enable_Button_Events() .

NOTES

Get_Button() and Show_Button() both return the same information to your program. Get_Button() is a high-level routine that does a series of actions. Show_Button() is a low-level routine whose only function is to extract one piece of information from the database.

The Show routines can be called repeatedly on the same current event without harm, if that's convenient to your program.

If the current event is not a button-type event, or if there is no current event, the system will complain upon a call to Show_Button() .

RESTRICTIONS

See also
Await_Event, Get_Button, Enable_Button_Events, Show_Button_Source, Requeue_Event.