Erase Text Line at specified Cursor Position

This Subprogram erases the line of Text 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 = UIERLI([YCOR])

Long Name Calling Sequence

STATUS = UI_ERASE_LINE(...)

Input Arguments

YCOR (Real) Row (Y) (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 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 (however, when calling this Subprogram as a Function a null Argment must be specified). The YCOR Argument must be specified as a floating point number.