GetCharacters Method (IAlcScreen)

In This Topic

Gets ScreenCharacter objects from the specified screen location. Each object represents one character.

Syntax

Visual Basic
C#

'Declaration
 
Function GetCharacters( _
   ByVal row As Integer, _
   ByVal column As Integer, _
   ByVal length As Integer _
) As ScreenCharacter()

'Usage
 
Dim instance As IAlcScreen
Dim row As Integer
Dim column As Integer
Dim length As Integer
Dim value() As ScreenCharacter
 
value = instance.GetCharacters(row, column, length)

ScreenCharacter[] GetCharacters( 
   int row,
   int column,
   int length
)

Parameters

row: The character row position.
column: The character column position.
length: The character length.

Return Value

ScreenCharacter object.

Exceptions

Exception	Description
System.ArgumentOutOfRangeException	This exception is thrown if the row or column parameters are outside the range of valid values: (1 to Rows) or (1 to Columns).

Remarks

The length argument specifies the number of screen bytes to get. In SBCS, the number of screen bytes is equal to the number of ScreenCharacter objects. In DBCS, the two numbers may differ. If the last byte is half of a DBCS character, it is not returned.

Reference

IAlcScreen Interface
IAlcScreen Members

Send Feedback