Translate page

Field.GetNextLength Method


Returns the length of the next field of the specified type, starting at the specified screen position.

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

Syntax


C#
public StatusCode GetNextLength(
	ScreenPosition position,
	ref int length,
	FieldType fieldType
)
Visual Basic (Declaration)
Public Function GetNextLength ( _
	position As ScreenPosition, _
	ByRef length As Integer, _
	fieldType As FieldType _
) As StatusCode
Visual C++
public:
virtual StatusCode GetNextLength(
	ScreenPosition position, 
	int% length, 
	FieldType fieldType
) sealed
JavaScript
function GetNextLength(position, length, fieldType);

Parameters

position Type: JollyGiant.Emulation..::.ScreenPositionScreen position where the search starts.

length Type: System..::.Int32   Will on return contain the length of the field.

fieldType Type: JollyGiant.Emulation..::.FieldTypeFieldType to get the length for.

Return Value

The StatusCode indicating the result of the operation.

This can be one of the following values:


Status codeDescription
WHLLOKThe specified field length was found.
WHLLNOTCONNECTEDYour application is not currently connected to a host session.
WHLLPARAMETERERROROne or more of the call parameters are invalid.
WHLLPOSITIONERRORThe specified presentation space position is invalid.
WHLLSYSERRORThe method failed due to a system error.
WHLLNOFIELDThe specified field was not found, or the session presentation space is unformatted.
WHLLZEROLENFIELDThe specified field has a length of zero (only an attribute byte, no text entry or display possible.

Implements

IField..::.GetNextLength(ScreenPosition, Int32%, FieldType)

Remarks

The attribute byte of a IField is not included in it's length.

See Also

Send comments on this topic to Jolly Giant Software

Copyright 2009 by Jolly Giant Software, Inc.