Display Text Characters at specified Cursor Position

This Subprogram displays the specified Characters at the specified Cursor Position within the currently setup Viewport (see UI_USE_VIEWPORT or UI_DEFINE_VIEWPORT) in the currently setup Viewport Mode (see UI_VIEWPORT_MODE).

Short Name Calling Sequence

STATUS = UIDICH(TEXT[,XCOR,YCOR,STYLE])

Long Name Calling Sequence

STATUS = UI_DISPLAY_CHARS(...)

Input Arguments

TEXT (Character) Text String XCOR (Real) Column (X) (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. For a Text Viewport to be made visible it must be displayed via a call to UI_DISPLAY_VIEWPORT. This may be performed either prior to, or following, this call.
2. The XCOR Argument is optional and, if present, specifies the X Coordinate (Column Number) at which the Characters are to be displayed. If absent, the current X Coordinate is used by default. The XCOR Argument must be specified as a floating point number.
3. The YCOR Argument is optional and, if present, specifies the Y Coordinate (Row Number) at which the Characters are to be displayed. If absent, the current Y Coordinate is used by default. 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 current Viewport. 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.

5. The color and (on graphics displays) the font etc. may be defined using subprograms from the CDFMENU Package (CDF-236).