Copy String to Presentation Space

Copy String to Presentation Space – Function 15

This function copies an ASCII string directly to a specified position in the Host session presentation space.

Prerequisite functions

Connect Presentation Space (function 1)

Function call

WinHLLAPI(COPYSTRTOPS,lpbyString,lpwLength,lpwReturnnCode)

Call parameters

Parameter	Description
Data String	String of ASCII data to copy to the Host session presentation space.
Data Length	Number of characters. NA if session option EOT is specified.
PS Position	Position in the Host session presentation space where Data String is to be copied.

Return code

Code	Description
WHLLOK	Data String successfully copied.
WHLLNOTCONNECTED	Your Windows HLLAPI application is currently not connected to a session.
WHLLPARAMETERERROR	Data Length has a value of zero (invalid).
WHLLPOSITIONERROR	PS Position value is invalid.
WHLLTRUNCATED	Data String was truncated during the copy (partial copy).
WHLLINHIBITED	The Host session presentation space is protected or inhibited, or Data String contains illegal data (such as a field attribute byte).
WHLLSYSERROR	The function failed due to a system error.

Remarks

Position in the Host session presentation space is determined by starting in the upper left corner of the screen display (row 1, column 1). At the end of each screen display row, the next Host session presentation space position is column 1 of the following screen display row. This process continues until the end of the Host session presentation space (screen display) is reached.

This function is affected by the session options STRLEN/STREOT and EOT=c. If the session option STREOT has been specified, the copy string ends when an EOT is encountered in Data String. See Set Session Parameters (9) for details.

This function is similar to, but faster than, Send Key (3). However, keyboard mnemonics that can be sent with Send Key cannot be sent with this function.

Data String cannot be larger than the maximum size of the Host session presentation space.

5250 emulators supports a Presentation Space of 24 rows by 80 columns. When an error message from the host or when the operator presses the SysReq key, a 25th row is displayed. When the row 25 is displayed, it is a valid area for this function.