HIDE_CURRENT_FORM Function

RAMP-TS

HIDE_CURRENT_FORM Function

Hides the current form and displays an optional message.

This function is used to hide the current 5250 screen from the users and to prevent them from manually interacting with it.

For example, a script that performed a 5250 sub-file search and failed to find an expected product number might do this:

 

HIDE_CURRENT_FORM("Product number", strProductNumber, "could not be found. You may not be authorized to view it.");

 

This presents an error message to the user and hides the current 5250 form, which can then only be interacted with by other script controlled actions.         

Syntax

HIDE_CURRENT_FORM([sMessageText1] [, sMessageText2] ... [, sMessageTextN])

Parameters

sMessageText1

Optional. String that contains the first message to be issued. 

sMessageText2 -> N

Optional. Strings that are to be concatenated with the previous message text (a separator space is added). 

 

Return Value

None

 

Notes

This request may be handled asynchronously. The consequences of invoking it may not be visible or useable until your currently active RAMP-TS script(s) complete executing and yields control back to the RAMP-TS manager.

 

Example

 

HIDE_CURRENT_FORM("Inventory item", objListManager.AKey1[0] , "was deleted.");