Output Text switched by UIPACK Operation Mode

This Subprogram outputs the specified text string to the currently setup UIPACK output device where the mode of output is dependent on the current UIPACK Operation Mode.

Short Name Calling Sequence

STATUS = UIOUTX(TEXT[,VPRTID,YCOR,STYLE])

Long Name Calling Sequence

STATUS = UI_OUTPUT_TEXT(...)

Input Arguments

TEXT (Character) Text String VPRTID (Integer) Viewport ID (Optional) YCOR (Real) Row (Y) (Optional) STYLE (Integer) Text Style (Optional)

Output Arguments

None

Function Value

UI__SUCCESS ) Success UISUCC )

UI__NOT_INITIALIZED ) Package not Initialized UININI )

UI__ILLEGAL_VIEWPORT ) Illegal Viewport ID UIILVP )

Note:

1. The specified text will be displayed on the current UIPACK output device in the following manner depending on the current UIPACK Operation Mode:-

   

   For Prompted and Scroll Modes the Optional Arguments VPRTID, YCOR and STYLE are ignored.

2. The VPRTID Argument is optional and, if present, specifies the Viewport within which the text line is to be displayed. It is ignored in Prompted or Scroll Modes and defaults to the current Viewport if not present for ViewText, ViewCursor or Graphics Modes.
3. The YCOR Argument is optional and, if present, specifies the Y Coordinate (Row Number) at which the Characters are to be displayed. It is ignored in Prompted or Scroll Modes and defaults to the current Y Coordinate if not present for ViewText, ViewCursor or Graphics Modes. The YCOR Argument must be specified as a floating point number.
4. The STYLE Argument is optional and, if present, overrides the default text style for the Viewport. It is ignored in Prompted or Scroll Modes and defaults to the current text style if not present for ViewText, ViewCursor or Graphics Modes. A Style of Zero is the normal (not bold, blinking, underlined etc.) and alternative styles may be specified by combining the following Style Masks (by ORing them together):-

   UISBLI ) Blinking UISTYLEBLINK )

   UISBOL ) Bold UISTYLEBOLD )

   UISREV ) Reverse Video UISTYLEREVERSE )

   UISUND ) Underlined UISTYLEUNDERLINE )

   These Parameters are defined in the Parameter Definition File described in Appendix B.3.