Copy Presentation Space

Copy Presentation Space – Function 5

This function copies the contents of the current Host session’s presentation space into a string buffer.

Prerequisite functions

Connect Presentation Space (function 1)

Function call

WinHLLAPI(COPYPS,lpbyString,lpwLength,lpwReturnnCode)

Call parameters

Parameter	Description
Data String	String that will contain the Host session presentation space. The string length must be defined as the maximum size of the presentation space. If the session option EAB has been set with Set Session Parameters (function 9), the string length must be defined to be at least twice the size of the presentation space.
Data Length	NA (the length of the presentation space is assumed).
PS Position	NA

Return parameters

Parameter	Description
Data Length	String containing the Host session presentation space.

Return code

Code	Description
WHLLOK	String; the session is active and the keyboard is unlocked.
WHLLNOTCONNECTED	Your Windows HLLAPI application is currently not connected to a session.
WHLLPSBUSY	Host session presentation space successfully copied to Data String; the session is waiting for a Host response.
WHLLINHIBITED	Host session presentation space successfully copied to Data String; the keyboard is locked
WHLLSYSERROR	The function failed due to a system error.

Remarks

This function copies the entire Host session presentation space to the supplied string. To copy only a portion of the presentation space, use Copy Presentation Space to String (function 8).