|
The Copy OIA function returns the current operator information area (OIA) data from the host-connected presentation space.
The OIA is located under the bottom dividing line of the screen and is used to display session status information about the connection between the workstation and the host.
Prerequisite Calls
Connect Presentation Space (1)
Call Parameters
|
Standard Interface
|
Enhanced Interface
|
Function Number
|
Must be 13
|
|
Data String
|
Preallocated target data string
|
|
Length
|
103
|
104
|
PS Position
|
NA
|
|
Return Parameters
This function returns a data string and a return code.
Data String
A 103-byte string for 16-bit and 104-byte string for 32-bit.
Return Code
The following codes are defined:
Return Code
|
Explanation
|
0
|
OIA data is returned. The target presentation space is unlocked.
|
1
|
Your program is not connected to a host session.
|
2
|
An error was made in specifying string length. OIA data was not returned.
|
4
|
OIA data is returned. The target presentation space is busy.
|
5
|
OIA data is returned. The target presentation space is locked. (Input inhibited)
|
9
|
An internal system error was encountered. OIA data was not returned.
|
Remarks
| 1. | The OIA Group consists of the bits that show the status of the connected sessions. The group is categorized by the represented host function. (For example, Group 8 consists of the bits that show all conditions of the input inhibit in the session.) The states of each group are ordered so that the high-order bits represent the indicators of higher priority. That is, bit 7 has priority over bit 0. Therefore, if more than one state is active within a group, the state with the highest priority is the active state within that group. |
| 2. | To use this function, preallocate memory to receive the returned data string parameter. The statements required to preallocate this memory vary depending on the language in which your application is written. |
|