Q_CHECK_CURRENT_FORM Function

RAMP-TS

previous page next page

Q_CHECK_CURRENT_FORM Function

Check that RAMP is showing a screen, the request is queued up and processed when the next screen arrives.

Syntax

Q_CHECK_CURRENT_FORM(sFormName [, sMessageText1] [, sMessageText2] ...)

Parameters

sFormName

Required. String that specifies the Name of the Form

sMessageText1

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

sMessageText2

Optional. Other strings that are to be concatenated with the first message string (a separator space is automatically added between each string). 

 

Return Value

Boolean. Returns one of the following possible values:

true

The form currently shown has the form name specified.

false

The form currently shown does not have the form name specified.

 

Remarks

Used for checking whether the script or user has progressed to a particular screen, or has stopped at an earlier screen.

Example

 

 

 

previous page start next page