Velocity API: Screen.getText()

Version 1

    Return To Index

    Screen.getText()

    Overview

    Get text from the native emulation screen. Only valid for TE hosts.

    Use Cases

    • You would like to change how a script processes scan data based on screen content.

    Format

     

    var text = Screen.getText(row, column, length);
    ParameterDescriptionTypeRequiredNotes
    rowThe native screen row. 0 based.NumberRequired
    columnThe native screen column. 0 based.NumberRequired
    lengthThe number of columns to read.NumberOptionalIf not specified, then the specified row will be read to the end.

     

    Example

    /* Read 5 characters from the screen from the 1st row starting at the 6th column 
    */
      
    var text = Screen.getText(0, 5, 5);