Returns the specified portion of the presentation space in a string format.


Namespace: ScreenUPG
Assembly: ScreenUPG (in ScreenUPG.dll)

Syntax

Visual Basic (Declaration)
Public Function getExtPS( _ 
   ByVal inStartRow As Integer,  _ 
   ByVal inStartColumn As Integer,  _ 
   ByVal inLength As Integer _ 
) As String
C#
public string getExtPS(
   int inStartRow,
   int inStartColumn,
   int inLength
)
C++
public:
 String getExtPS(
   int inStartRow,
   int inStartColumn,
   int inLength
) sealed 
J#
public string getExtPS(
   int inStartRow,
   int inStartColumn,
   int inLength
)
JScript
public  function getExtPS(
   inStartRow : int,
   inStartColumn : int,
   inLength : int
) : String

Parameters

inStartRow
inStartColumn
inLength

Return Value

A string containing the specified contents of presentation space. Each character in the returned string is followed immediately by the extended character and extended color information for that character. As a result, the return string will contain three times the number of presentation space positions (characters) than you specify.

Remarks

See Extended Character and Color Attributes for a list of attributes returned for each host type.

Example

[C#]

 Copy Code 
            boolean isUnderscore = false;
            boolean isBlinking = false;
            boolean isForegroundBlue = false;
            boolean isBackgroundYellow = false;
            
            // Get presentation space from home position
            string ps = screen.getExtPS(1, 1, 1000);
            char character = ps[0];
            char attribute = ps[1];
            char color = ps[2];
            
            // Character attributes
            if ((attribute & ScreenUPG.ScreenUPG.Underscore) != 0)
                isUnderscore = true;
            if ((attribute & ScreenUPG.ScreenUPG.Blink) != 0)
                isBlinking = true;
                
            // Character color attributes
            if ((color & ScreenUPG.ScreenUPG.FgBlue) != 0)
                isForegroundBlue = true;
            if ((color & ScreenUPG.ScreenUPG.BgYellow) != 0)
                isBackgroundYellow = true;
[VB]
 Copy Code 
            Dim isBlink As Boolean
            Dim isUnderline As Boolean
            Dim isNegative As Boolean
            Dim attribute As Integer
            Dim color As Integer
            Dim ps As String
            
            Get the presentation space at row 18, column 6 with length 10
            ps = screen.getExtPS(18, 6, 10)
            attribute = Mid$(ps, 2, 1)
            color = Mid$(ps, 3, 1)
            if ((attribute And screen.Blink) >< 0) then isBlink = True
            if ((attribute And screen.Underscore) >< 0) then isUnderline = True
            if ((attribute And screen.Reverse) >< 0) then isNegative = True

See Also

Syntax based on .NET Framework version 2.0.
Documentation version 1.0.0.0.