PutText(String,Int32,Int32,Int32) Method

In This Topic

Puts text at the specified screen location.

Syntax

Visual Basic
C#

'Declaration
 
Overloads Function PutText( _
   ByVal text As String, _
   ByVal row As Integer, _
   ByVal column As Integer, _
   ByVal length As Integer _
) As ReturnCode

'Usage
 
Dim instance As IAlcScreen
Dim text As String
Dim row As Integer
Dim column As Integer
Dim length As Integer
Dim value As ReturnCode
 
value = instance.PutText(text, row, column, length)

ReturnCode PutText( 
   string text,
   int row,
   int column,
   int length
)

Parameters

text: Text to put on screen.
row: Row position on which to put the text.
column: Column position on which to put the text.
length: Number of byte positions available for the text.

Return Value

ReturnCode indicates success, failure, or a warning condition if the cursor position reaches the screen boundary.

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

If the text string is longer than "length", the text is truncated.

Reference

IAlcScreen Interface
IAlcScreen Members
Overload List

Send Feedback