User`s guide

xxxiv Contents
Copy Presentation Space to String—Function 8
This function copies all or part of the Host session presentation space into a string buffer.
Prerequisite Functions
Connect Presentation Space (function 1).
WinHLLAPI(COPYPSTOSTR,lpbyString,lpwLength,lpwReturnnCode)
Parameter Description
Data String String that will contain the specified portion of the Host
session presentation space.
Note: If the EAB option is set under Set Session
Parameters (9) to include extended attribute bytes in the
copy, the string must be defined as at least twice the size of
the presentation space that is copied.
Data Length Number of characters.
PS Position Position in the Host session presentation space where the
copying is to begin. Must be greater than zero and less than
or equal to the maximum size of the Host session
presentation space.
Parameter Description
Data String String containing the specified portion of the Host session
presentation space.
Code Description
WHLLOK
The specified portion of the Host session presentation space
successfully copied to Data String; the session is active and
the keyboard is unlocked.
WHLLNOTCONNECTED Your Windows HLLAPI application is not currently
connected to a session.
WHLLPARAMETERERROR Data Length of zero specified.
WHLLPSBUSY
The specified portion of the Host session presentation space
successfully copied to Data String; the session is waiting
for a Host response.
WHLLINHIBITED
The specified portion of the Host session presentation space
successfully copied to Data String; the keyboard is locked.
WHLLPOSITIONERROR PS Position value specified is invalid.
WHLLSYSERROR The function failed due to a system error.
Function Call
Call Parameters
Return Parameters
Return Codes