User`s guide

xxii Contents
Copy Field to String—Function 34
This function copies the contents of a specified field in the Host session presentation space to a string.
You can use Copy Field to String for either protected or unprotected fields.
Prerequisite Functions
Connect Presentation Space (function 1).
WinHLLAPI(COPYFIELDTOSTRING,lpbyString,lpwLength,
lpwReturnnCode)
Parameter Description
Data String Buffer to hold the copied field. If session option EAB is
set, must be defined at least twice the length of the field to
be copied.
Data Length Number of characters to copy.
PS Position The position in the Host session presentation space of the
field to be copied. This value may be any byte within the
field, since the copy always starts at the beginning of the
field.
Parameter Description
Data String Data copied from the specified field. The first byte of Data
String is the first byte in the specified field.
Code Description
WHLLOK The specified field was copied successfully.
WHLLNOTCONNECTED Your Windows HLLAPI application is not currently
connected to a Host session.
WHLLPARAMETERERROR One or more call parameters are invalid.
WHLLTRUNCATED The specified field was copied, but the data to be copied
and Data String were not the same size. If Data String is
smaller than the specified field, the remaining copy data is
truncated.
WHLLPOSITIONERROR PS Position is invalid.
WHLLSYSERROR The function failed due to a system error.
WHLLNOFIELD The Host session presentation space is unformatted.
Function Call
Call Parameters
Return Parameters
Return Codes