Copy OIA – Function 13

This function returns the Host session Operator Information Area (OIA).

Prerequisite functions

Connect Presentation Space (function 1)

Function call

WinHLLAPI(COPYOIA,lpbyString,lpwLength,lpwReturnnCode)

Call parameters

Parameter	Description
Data String	String buffer to hold the OIA. Must be defined for at least 103 bytes.
Data Length	Length of Data String in characters.
PS Position	NA

Return parameters

Parameter	Description
Data String	A 103-byte string containing a copy of the OIA.

Return code

Code	Description
WHLLOK	OIA copied successfully.
WHLLNOTCONNECTED	Your Windows HLLAPI application is currently not connected to a session.
WHLLPARAMETERERROR	OIA not copied; Data Length contains an invalid value.
WHLLPSBUSY	OIA copied successfully; Host session is busy.
WHLLINHIBITED	OIA copied successfully; Host session is locked (input inhibited).
WHLLSYSERROR	The function failed due to a system error.

Remarks

The 103-byte string returned in Data String contains three areas of information, as follows:

Byte 1	OIA format, “1” for 3270 or “9” for 5250.
Bytes 2-81	OIA image in binary format.
Bytes 82-103	OIA group indicator meanings. Unused positions are set to 00h.