|
The copyPresentationSpace function copies the contents of the host-connected presentation space into a data string that you define in your hllapi.js web application program.
Prerequisite Calls
connectPresentationSpace
Call Parameters
Parameter name
|
Explanation
|
params
|
An object containing a subset of Session Options parameters, which values will take precedence over the defaults for the execution context of this function.
|
Return Properties
Property name
|
Explanation
|
data
|
Contents of the connected host presentation space.
|
returnCode
|
A numeric code indicating the execution status of the function. Please refer to the Return Code table below for all possible values.
|
length
|
The length of the data copied.
|
Return Code
The following values are defined for the 'returnCode' property:
Return Code
|
Explanation
|
0
|
The host presentation space contents were copied to the application program. The target presentation space was active and the keyboard was unlocked.
|
1
|
Your program is not connected to a host session.
|
4
|
The host presentation space contents were copied. The connected host presentation space was waiting for host response.
|
5
|
The host presentation space was copied. The keyboard was locked.
|
Remarks
| 1. | This function is equivalent to HLLAPI Function Number 5. |
| 2. | An EAB can be returned when the EAB option is included in 'params' parameter. |
| 3. | The copyPresentationSpace function is affected by the following session options: ATTRB/NOATTRB/NULLATTRB, EAB/NOEAB, XLATE/NOXLATE, BLANK/NOBLANK, DISPLAY/NODISPLAY. |
|