Translate page

Screen.GetScreenWithAttribs Method

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

Gets the contents of the screen from the currently connected session, with character attributes. The format of the returned string will be alternating, one character of text, one attribute (can be 0)

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

Syntax

C#
public StatusCode GetScreenWithAttribs(
	out byte[] screen
)
Visual Basic (Declaration)
Public Function GetScreenWithAttribs ( _
	<OutAttribute> ByRef screen As Byte() _
) As StatusCode
Visual C++
public:
virtual StatusCode GetScreenWithAttribs(
	[OutAttribute] array<unsigned char>^% screen
) sealed
JavaScript
function GetScreenWithAttribs(screen);


Parameters

screen
Type: System.Byte []
Buffer for the 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 buffer; the session is active and the keyboard is unlocked.
WHLLNOTCONNECTEDYour application is 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.


Implements

IScreen.GetScreenWithAttribs(Byte[])

See Also


Screen Class
JollyGiant.Emulation Namespace
ISession.Connect(Object)

Send comments on this topic to Jolly Giant Software

Copyright 2009 by Jolly Giant Software, Inc.