PutCharacter Method

In This Topic

Puts a ScreenCharacter at the specified screen location.

Syntax

Visual Basic (Declaration)

expression.PutCharacter( _
   ByVal character As ScreenCharacter, _
   ByVal row As Integer, _
   ByVal column As Integer _
) As ReturnCode

where expression is a variable that represents a IbmScreen Object

Parameters

character: A screen character. This is a ScreenCharacter Object.
row: The screen row on which to put the character.
column: The screen column on which to put the character.

Return Value

One of the following ReturnCode enum values.

Member	Description
Cancelled	Cancelled.
Error	Error.
PermissionRequired	Permission is required.
Success	Success.
Timeout	Timeout condition.
Truncated	The text is truncated.

Exceptions

Exception	Description
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 ScreenCharacter is a DBCS character, the character takes a two-byte space starting at the specified screen location.

Example

This example gets a character from a screen location and puts it on another location.

Visual Basic

Sub PutCharExample()
 
    Dim screeenchar As ScreenCharacter
    Dim rcode As ReturnCode
    
    Set screeenchar = ThisIbmTerminal.screen.GetCharacter(12, 18)
    
    rcode = ThisIbmTerminal.screen.PutCharacter(screeenchar, 5, 19)
    
    If rcode = ReturnCode_Success Then
    
        Debug.Print "success!"
        
    End If
    
End Sub

Reference

IbmScreen Object
IbmScreen Members

Send Feedback