Translate page

Screen.GetStringWithAttribs Method

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

Copies all or part of the screen into a buffer, including extended attributes.

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

Syntax

C#
public StatusCode GetStringWithAttribs(
	int row,
	int column,
	ref string screen,
	int charsToCopy
)
Visual Basic (Declaration)
Public Function GetStringWithAttribs ( _
	row As Integer, _
	column As Integer, _
	ByRef screen As String, _
	charsToCopy As Integer _
) As StatusCode
Visual C++
public:
virtual StatusCode GetStringWithAttribs(
	int row, 
	int column, 
	String^% screen, 
	int charsToCopy
) sealed
JavaScript
function GetStringWithAttribs(row, column, screen, charsToCopy);


Parameters

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

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

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

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

Return Value

The StatusCode indicating the result of the operation.

This can be one of the following values:

Status codeDescription
OkThe specified portion of the presentation space was 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)).
WHLLPARAMETERERRORcharsToCopy of zero specified.
WHLLPSBUSYThe specified portion of the presentation space was successfully copied to the buffer; the session is waiting for a host response.
WHLLINHIBITEDThe specified portion of the presentation space was successfully copied to the buffer; the keyboard is locked.
WHLLPOSITIONERRORPresentation space position specified is invalid.
WHLLSYSERRORThe method failed due to a system error.


Implements

IScreen.GetStringWithAttribs(Int32, Int32, String, Int32)

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.