Translate page

IScreen_GetScreen Method

Owned by Julio Rios (Unlicensed)
Last updated: May 16, 2017
1 min read

Gets the contents of the screen from the current session as plain text, without extended attributes.

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

Syntax

C#
StatusCode GetScreen(
	ref string screen
)
Visual Basic (Declaration)
Function GetScreen ( _
	ByRef screen As String _
) As StatusCode
Visual C++
StatusCode GetScreen(
	String^% screen
)
JavaScript
function GetScreen(screen);


Parameters

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

Return Value

The StatusCode indicating the result of the operation.

This can be one of the following values:

Status codeDescription
OkSession presentation space successfully copied to the screen buffer; the session is active and the keyboard is unlocked.
WHLLNOTCONNECTEDYou are not currently connected to a session (see Connect(Object)).
WHLLPSBUSYSession presentation space successfully copied to the screen buffer; the session is waiting for a host response.
WHLLINHIBITEDSession presentation space successfully copied to the screen buffer; the keyboard is locked.
WHLLSYSERRORThe method failed due to a system error.


See Also


IScreen Interface
JollyGiant.Emulation Namespace
ISession..::.Connect(Object)

Send comments on this topic to Jolly Giant Software

Copyright 2009 by Jolly Giant Software, Inc.