copyStringToPresentationSpace
|
Top
Previous
Next
|
|
The copyStringToPresentationState function copies an ASCII data string directly into the host presentation space at the location specified by the PS position calling parameter.
Prerequisite Calls
connectPresentationSpace
Call Parameters
Parameter name
|
Explanation
|
input
|
String of ASCII data to be copied into the host presentation space.
|
position
|
Position in the host presentation space to begin the copy, a value between 1 and the configured size of your host presentation space.
|
params
|
An object containing a subset of Session Options parameters, which values will take precedence on the defaults for the execution context of this function.
|
Return Properties
Property name
|
Explanation
|
returnCode
|
A numeric code indicating the execution status of the function. Please refer to the Return Code table below for all possible values.
|
Return Code
The following values are defined for the 'returnCode' property:
Return Code
|
Explanation
|
0
|
The copyStringToPresentationSpace function was successful.
|
1
|
Your program is not connected to a host session.
|
Remarks
| 1. | This function is equivalent to HLLAPI Function Number 15. |
| 2. | The copyStringToPresentationSpace function is affected by the following session options: STRLEN/STREOT, EOT, EAB/NOEAB, XLATE/NOXLATE, PUTEAB/NOPUTEAB. |
| 3. | The keyboard mnemonics (see sendKey function) cannot be sent using the copyStringToPresentationSpace function. |
| 4. | The string ends when an end-of-text (EOT) delimiter is encountered in the string if EOT mode was selected using the 'params' parameter. |
| 5. | Although the sendKey function accomplishes the same purpose, this function responds with the prompt and enters a command more quickly. Because the sendKey function emulates the terminal operator typing the data from the keyboard, its process speed is slow for an application operating with a lot of data. This function provides a faster input path to the host. |
| 6. | The original data (the copied string) cannot exceed the size of the presentation space. |
|