RESTART_LAST_NAVIGATION Function

RAMP-TS

RESTART_LAST_NAVIGATION Function

Restarts to the last navigation plan when the next screen arrives. 

Syntax

RESTART_LAST_NAVIGATION()

 

Parameters

None.

Return Value

"" (null string) or the last function key used.

Remarks

This function is used to restart the last navigation performed or to resend the last key.

Typically it is used in the arrival script of an unknown or special screen that needs to be logically eliminated from the screen flow during a navigation – for example a break message screen.

A call to this function needs to be followed by a SENDKEY() function call to cause the current screen to be removed from the screen flow.

When the break message screen appears while navigating between two screens, the function should return "" (null string). When the next screen arrives the navigation plan that was in progress is restarted and replanned to resume the screen flow.

If it appears during a user initiated action like pressing a function key or button, the function returns the last function key that was used before the break message screen appeared. This allows the user to re-send the last key to continue the screen flow.

Example

var lastFkey = RESTART_LAST_NAVIGATION();

SENDKEY(KeyF3);

if (lastFkey != "") Q_SENDKEY("",lastFkey); /* queue sending of the last function key before the break message screen appeared */

 

Note that this function should only be invoked from an arrival script and would almost always need to be immediately followed by a SENDKEY() function call to cause the current screen to be removed.