InfoConnect API Guide
Attachmate.Reflection.Emulation.OpenSystems Namespace / IScreen Interface / GetCharacters Method
screen row position
screen column position
The number of characters to obtain.


In This Topic
    GetCharacters Method (IScreen)
    In This Topic
    Gets ScreenCharacter objects from the specified location, each representing one character at a screen location. The length argument specifies the number of screen bytes to get. In SBCS, the number of screen bytes is the same as that of ScreenCharacter objects. In DBCS, the two numbers can be different. If the last byte is only one half byte of a DBCS character, the last byte is not returned.
    Syntax
    'Declaration
     
    
    Function GetCharacters( _
       ByVal row As Integer, _
       ByVal column As Integer, _
       ByVal length As Integer _
    ) As IScreenCharacter()
    'Usage
     
    
    Dim instance As IScreen
    Dim row As Integer
    Dim column As Integer
    Dim length As Integer
    Dim value() As IScreenCharacter
     
    value = instance.GetCharacters(row, column, length)

    Parameters

    row
    screen row position
    column
    screen column position
    length
    The number of characters to obtain.

    Return Value

    Array of ScreenCharacter for the specified position.
    Exceptions
    ExceptionDescription
    This exception is thrown if the row or column parameters are outside the range of valid values (1 to Rows) or (1 to Columns).
    See Also