Copies all or part of the host session presentation space into a buffer.

Namespace: JollyGiant.Emulation
Assembly: JGSComdotNet (in JGSComdotNet.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C#
public StatusCode GetString( int row, int column, ref string screen, int charsToCopy )

Visual Basic (Declaration)
Public Function GetString ( _ row As Integer, _ column As Integer, _ ByRef screen As String, _ charsToCopy As Integer _ ) As StatusCode

Visual C++
public: virtual StatusCode GetString( int row, int column, String^% screen, int charsToCopy ) sealed

JavaScript
function GetString(row, column, screen, charsToCopy);

row
Type: System..::.Int32Screen Int32
Screen row where the copy is to start.

column
Type: System..::.Int32Screen Int32
Screen column where the copy is to start.

screen
Type: System..::.String %Buffer
Buffer for screen contents.

charsToCopy
Type: System..::.Int32Number Int32
Number of characters to copy.

The StatusCode indicating the result of the operation.

This can be one of the following values:

Status code	Description
Ok	The specified portion of the presentation space was successfully copied to the buffer; the session is active and the keyboard is unlocked.
WHLLNOTCONNECTED	Your application is not currently connected to a session (see Connect(Object)).
WHLLPARAMETERERROR	charsToCopy of zero specified.
WHLLPSBUSY	The specified portion of the presentation space was successfully copied to the buffer; the session is waiting for a host response.
WHLLINHIBITED	The specified portion of the presentation space was successfully copied to the buffer; the keyboard is locked.
WHLLPOSITIONERROR	Specified position is invalid.
WHLLSYSERROR	The method failed due to a system error.

Versions Compared