Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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)

Image RemovedSyntax

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


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


Visual C++
StatusCode GetLength(
	ScreenPosition position, 
	int% length
)


JavaScript
function GetLength(position, length);


Parameters

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

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

Return Value

The StatusCode indicating the result of the operation.

This can be one of the following values:

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


Image RemovedRemarks


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

Image RemovedRemarks


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

Image RemovedSee Also


IField Interface
JollyGiant.Emulation Namespace

Send comments on this topic to Jolly Giant Software

...