COPY OIA (13)

3270 Host Connection Program 2.1 and 1.3.3 for AIX: Guide and Reference

COPY OIA (13)

Purpose

Returns the current Operator Information Area (OIA) data from the host Presentation Space (PS).

Prerequisite Calls

This function requires a prerequisite call to the CONNECT PRESENTATION SPACE (1) function.

Syntax

hllc (func, apistring, len, ret)
int *func;
char *apistring;
int *len;
int *ret;

Supplied Parameters

Supply the following parameters to invoke the COPY OIA function:

func	Specifies the number of the function called; must be a 13 for the COPY OIA function.
apistring	Specifies the preallocated target data string for the COPY OIA function.
len	Specifies the data string length; must be a minimum of 103 bytes.
ret	Does not apply for the COPY OIA function. Should be set to NULL.

Returned Parameters

apistring

A 103-byte string containing the OIA data strings following:

Position 1	OIA format byte (1 for 3270)
Positions 2-81	OIA image of the connected host session: 2-7 Readiness and System Connection Information

field

10-18 Input-Inhibit field
23-29 Communication Check Reminder field
53 Insert Mode field

Positions 82-103

OIA group indicator meanings.

ret

The following return codes are valid:

0	COPY OIA was successful.
1	Your program was not connected to the host session.
2	An error was made in specifying string length. OIA data was not returned.
4	OIA data was returned, but the host presentation space is busy.
5	OIA data was returned, but the host presentation space is locked (input inhibited).
9	An internal system error occurred. OIA data was not returned.

OIA Group Bit Meanings and Corresponding Images for 3270 Sessions

The following is a breakdown of each OIA group for 3270 terminal emulation sessions. The bits and starting column position in the OIA buffer are shown in the following tables. The images returned in 3270 PC format are also provided.

Note: Group 8 (byte 0) machine, communications, and program check images are followed by a three-digit number related to the type of check.

HCON can connect to multiple concurrent session types, the first byte of the OIA image indicates the active type. This byte can be used to discover the connectivity type during the program execution.

OIA Group

The following table shows all the possible HCON connections.

Symbol	Hex Value	Connection type
4	F4	3274 control unit attachment. A DFT session.
S	B2	3172 control unit attachment. A DFT session.
I	A8	4381 system attachment. A DFT session.
N	AD	9370 system attachment. A DFT session.
2	22	SNA standalone attachment using the SNA Services. This is a PU 2.1 node implementation over LAN or WAN.
T	B3	TCP/IP Telnet 3270 option attachment. This is a non-SNA connection.

Group 1

The following table describes Group 1 (offset 82), which defines online and screen ownership.

Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0-1	Reserved
2	SSCP-LU session (SNA)	2	F4CDF0F6F6F6
3	LU-LU session (SNA)	2	F4CDCFF6F6F6
	Session with host (Non-SNA)	2	F4CCCFF6F6F6
4	Online and not owned	2	F4CDF1F6F6F6
5	Subsystem ready	2	F4F6F6F6F6F6
6-7	Reserved

Group 2

The following table describes Group 2 (offset 83). Character selection is not supported.

Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0	Reserved
1	APL	37	A0AFABF6F6
2-7	Reserved

Group 3

The following table describes Group 3 (offset 84). Shift state is not supported.

Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0	Upper shift	43	F6E3F6
1	Numeric	43	ADB4AC
2-7	Reserved

Group 4

The following table describes Group 4 (offset 85). PSS group 1 is not supported.

Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0-7	Reserved

Group 5

The following table describes Group 5 (offset 86). Highlight group 1 is not supported.

Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0	Operator-selectable	48	E4
1	Field inherit	48	EFEB
2-7	Reserved

Group 6

The following table describes Group 6 (offset 87). Color group 1 is not supported.

Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0	Operator-selectable	50	EFE4
1	Field inherit	50	EFEB
2-7	Reserved

Group 7

The following table describes Group 7 (offset 88) which defines insert mode.

Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0	Insert mode	53	D0
1-7	Reserved

Group 8

The following tables describe the five bytes of Group 8 (offset 89-93). Input is inhibited in this group.

Byte 1 (offset 89)
Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0	Reserved
1	Reserved
2	Machine check	10	C6F6ACA0A2A7
3	Communications check	10	C6F6A2AEACAC
4	Program check	10	C6F6AFB1AEA6
5	Reserved
6	Device not working	10	C6F6FAC1FBF6F6F6F6
7	Reserved

Byte 2 (offset 90)
Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0	OIA time	10	C6F6FAC1FAC4CEF6F6
1	Terminal wait	10	C6F6C4C5F6F6F6F6F6
2	Reserved
3	Minus function	10	C6F63185F6F6F6F6F6
4	Too much entered	10	C6F6E408F6F6F6F6F6
5-7	Reserved

Byte 3 (offset 90)
Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0	Reserved
1	Operator-unauthorized	10	C6F6E466F6F6F6F6F6
2	Operator-unauthorized, minus function		C6F63185E4C6F6F6F6
3	Invalid dead key combination	10	C6F6E4F63518F6F6F6
4	Wrong place	10	C6F6C8E4E2F6F6F6F6
5-7	Reserved

Byte 4 (offset 92)
Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0	Reserved
2	System wait	10	C6F6B2B8B2B3A4ACF6
3-7	Reserved

Byte 5 (offset 93)
Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0-7	Reserved

Group 9

The following table describes Group 9 (offset 94). PSS group 2 is not supported.

Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0-7	Reserved

Group 10

The following table describes Group 10 (offset 95). Highlight group 2 is not supported.

Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0	Selected
1-7	Reserved

Group 11

The following table describes Group 11 (offset 96). Color group 2 is not supported.

Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0	Selected
1-7	Reserved

Group 12

The following table describes Group 12 (offset 97) which identifies a communications error.

Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0	Communications error	23	C1C0C2C3
1-7	Reserved

Group 13

The following table describes Group 13 (offset 98). Printer status is not supported.

Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0	Reserved
1	Printer malfunction	62	FAC1C9
2	Printer printing	62	FAC1C7
3	Printer assignment	62	FAC1FA
4-7	Reserved

Group 14

The following table describes Group 14 (offset 99). Graphics are not supported.

Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0-7	Reserved

Groups 15 and 16

The following table describes Group 15 (offset 100), which is a reserved group, and Group 16 (offset 101). Autokey play/record status is not supported in Group 16.

Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0-7	Reserved

Group 17

The following table describes Group 17 (offset 102). Autokey abort/pause status is not supported.

Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0-7	Reserved

Group 18

The following table describes Group 18 (offset 103). Enlarge state is not supported.

Bit	Meaning	Data String Starting Position	MFI Hex Code Points
0-7	Reserved

Remarks

To receive the current OIA information from the host PS, select the OIA option in the SET SESSION PARAMETERS (9) function. The OIA option in the SET SESSION PARAMETERS affects the format of the OIA image returned by the COPY OIA function. The only supported option is OLDOIA. The returned image is in the 3270 PC format.

OIA groups comprise bits representing the state of the connected session. Groups are divided by the host function they represent (for example, Group 8 contains all the bits representing input-inhibited conditions possible for the session). The bits in each group are ordered so that the high-order bits represent the states of higher priority. Therefore, if more than one state is active within a group, the state with the highest priority is the one represented in the OIA option for the session.

Related Information

CONNECT PRESENTATION SPACE (1) function and SET SESSION PARAMETERS (9) function.

[ Previous | Next | Contents | Search ]