User`s guide

xxiv Contents
Copy OIA—Function 13
This function returns the Host session Operator Information Area (OIA).
Prerequisite Functions
Connect Presentation Space (function 1).
WinHLLAPI(COPYOIA,lpbyString,lpwLength,lpwReturnnCode)
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
Parameter Description
Data String A 103-byte string containing a copy of the OIA.
Code Description
WHLLOK OIA copied successfully.
WHLLNOTCONNECTED Your Windows HLLAPI application is not currently
connected to a Host 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.
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.
Function Call
Call Parameters
Return Parameters
Return Codes
Remarks