Rice Lake iRite IDE - Manual (Page 47)

920i Programming Reference - API Reference 43
DisplayIsSuspended
Returns a true (non-zero) value if the display is suspended (using the SuspendDisplay procedure), or a false
(zero) value if the display is not suspended.
Method Signature:
function DisplayIsSuspended : Integer;
EnableHandler
Enables the specified event handler. See Section 6.1 on page 85 for a list of handlers.
Method Signature:
procedure EnableHandler (handler);
EventChar
Returns a one-character string representing the character received on a communications port that caused the
PortxCharReceived event. If EventChar is called outside the scope of a PortxCharReceived event, EventChar returns a
string of length zero. See Section 6.1 on page 85 for information about the PortxCharReceived event handler.
Method Signature:
function EventChar : String;
Example:
handler Port4CharReceived;
strOneChar : string;
begin
strOneChar := EventChar;
end;
EventKey
Returns an enumeration of type Keys with the value corresponding to the key press that generated the event. See
Section 4.0 on page 28 for a definition of the Keys data type.
Method Signature:
function EventKey : Keys;
Example:
handler KeyPressed;
begin
if EventKey = ClearKey then
…
end if;
end;
EventPort
Returns the communications port number that received an F#x serial command. This function extracts data from
the CmdxHandler event for the F#x command, if enabled. (The CmdxHandler, if enabled, runs whenever a F#x
command is received on any serial port.) If the CmdxHandler is not enabled, this function returns 0 as the port
number.
Method Signature:
function EventPort : Integer;
EventString
Returns the string sent with an F#x serial command. This function extracts data from the CmdxHandler event for
the F#x command, if enabled. (The CmdxHandler, if enabled, runs whenever a F#x command is received on any
serial port.) If the CmdxHandler is not enabled, or if no string is defined for the F#x command, this function
returns a string of length zero.
Method Signature:
function EventString : String;