Gets the length of the field (protected or unprotected) specified by the cursor position.

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

Syntax

C#
public StatusCode GetLength( ScreenPosition position, ref int length )

Visual Basic (Declaration)
Public Function GetLength ( _ position As ScreenPosition, _ ByRef length As Integer _ ) As StatusCode

Visual C++
public: virtual StatusCode GetLength( ScreenPosition position, int% length ) sealed

JavaScript
function GetLength(position, length);

position
Type: JollyGiant.Emulation.ScreenPosition
The position of the field in row/column coordinates.

length
Type: System..Int32
Will receive the length of the field.

The StatusCode indicating the result of the operation.

This can be one of the following values:

Status code	Description
WHLLOK	The length of the specified field was found.
WHLLNOTCONNECTED	Your application is not currently connected to a host session.
WHLLPARAMETERERROR	One or more of the call parameters are invalid.
WHLLPOSITIONERROR	The position argument specifies an invalid presentation space position.
WHLLSYSERROR	The method failed due to a system error.
WHLLNOFIELD	The specified field was not found, or the host session presentation space is unformatted.
WHLLZEROLENFIELD	The specified field has a length of zero.

Remarks

The specified cursor position does not have to mark the beginning of a field, but can be at any position inside the field.

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

Copyright 2009 by Jolly Giant Software, Inc.