Introduction

Getting Started

Programming Guides

API Reference

Additional Resources

Show_String_Source

Functions

void Show_String_Source (char *keyboard, HC_KEY *cursor_key)
 Returns the keyboard-device segment and cursor that gave rise to the current string event. More...
 

Detailed Description

Function Documentation

void Show_String_Source ( char *  keyboard,
HC_KEY cursor_key 
)

Returns the keyboard-device segment and cursor that gave rise to the current string event.

Parameters
keyboard- The segment associated with the physical keyboard device that initiated the current event. Passed by reference always. Returned to user.
cursor_key- The cursor being used for string echoing. Passed by reference always. Returned to user.

DETAILS

In HOOPS, events are trapped with routines like Await_Event() . Once Await_Event() has a current event, routines like Show_String_Source() , can be used to garner information about the event.

Show_String_Source() is one of a family of routines that extracts information from the current event (presumably a string event) and returns it to you. In particular, Show_String_Source() returns the keyboard device and cursor combination that was originally enabled for String events, which gave rise to the event now at hand. This information might be of interest if your program is handling several different string devices simultaneously.

NOTES

RESTRICTIONS

See also
Enable_String_Events, Show_String, Get_String.