GetPS Action

Extracts a portion of the actual host screen (Presentation Space) and stores it within a variable. If multiple lines are specified, then the data is stored as a string array.

Parameters

Row - (Optional)

Integer value specifying the start row of the portion of the PS to extract (ranging from 1 to 27). If not specified, row 1 is assumed.

Col - (Optional)

Specifies the starting column (ranging from 1 to 132). If not specified, column 1 is assumed.

Width - (Optional)

Specifies the number of characters to retrieve. If not specified, the width is assumed to be from the starting Col to the right edge of the window. If the starting Col plus the Width extends past the right edge of the window, the wrapped portion of the text is returned. In this case, Height must be equal to 1. If Height is not 1; the width is truncated to the right edge of the window.

Height - (Optional)

Specifies the number of rows of data to retrieve. If not specified, the height is assumed to be from the starting Row to the bottom of the window.

Variable - (Required)

Specifies the variable to receive the specified contents of the PS (presentation space).

Remarks

To determine the Row, Col, Width and Height arguments for the GetPS action, open the relevant screen in Identify. Using your mouse, select the area of the screen that you wish to extract. The Row and Column co-ordinates and height and width of your selection respectively are displayed in the Message Bar at the bottom of the screen. In the example screenshot below, the System output field would be extracted with the following line:

GetPS (2,70,1,8,varSystem)

Fig. 1 Sample Screenshot

This action is useful if you wish to check the contents of an area of the current screen and the co-ordinates of that area do not change, perhaps to ensure that the current screen is a particular screen before executing some logic. To determine the row and column position of a specific character on the host screen, open the screen in Identify and position your cursor on the character. The row and column position are specified in Position section of the Properties window or the message bar at the bottom of the screen.

Examples

The following example stores the 8x1 text in the field at row 2, column 70 on the host field as a variable. If this text is equal to "LOOK " it displays a message to the user.

GetPS (2, 70, 8, 1, varSystem)

varSystem = "LOOK " MsgBox (Alert, This is the LOOK system, MsgInformation, MsgOKOnly)

StopMacro

GetPS Action

Parameters

Remarks

Examples

See Also