Translate page

IField_SetText Method

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

Sets the text of the field at the specified position.

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

Syntax

C#
StatusCode SetText(
	ScreenPosition position,
	string fieldText
)
Visual Basic (Declaration)
Function SetText ( _
	position As ScreenPosition, _
	fieldText As String _
) As StatusCode
Visual C++
StatusCode SetText(
	ScreenPosition position, 
	String^ fieldText
)
JavaScript
function SetText(position, fieldText);


Parameters

position
Type: JollyGiant.Emulation..ScreenPosition
Screen position of the IField.

fieldText
Type: System..String
Text to copy into the field.

Return Value

The StatusCode indicating the result of the operation.

This can be one of the following values:

Status codeDescription
WHLLOKThe String was copied successfully.
WHLLNOTCONNECTEDYour application is not currently connected to a host session.
WHLLPARAMETERERRORYou attempted to copy a zero-length string.
WHLLINHIBITEDThe specified field is protected, or you attempted to copy invalid data (such as a field attribute).
WHLLTRUNCATEDThe String was copied successfully, but one or more characters were truncated (fieldText was longer than the field).
WHLLPOSITIONERRORThe specified presentation space position was invalid.
WHLLSYSERRORThe method failed due to a system error.
WHLLNOFIELDThe presentation space is unformatted.


See Also


IField Interface
JollyGiant.Emulation Namespace

Send comments on this topic to Jolly Giant Software

Copyright 2009 by Jolly Giant Software, Inc.