/
GetLength_Method.

GetLength_Method.


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#
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..ScreenPosition

The position of the field in row/column coordinates.

length Type: System..Int32

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.


Remarks


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

Remarks


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

See Also


IField Interface
JollyGiant.Emulation Namespace

Send comments on this topic to Jolly Giant Software

Copyright 2009 by Jolly Giant Software, Inc.



Related content

GetLength Method
GetLength Method
More like this
IField_GetLength Method
IField_GetLength Method
More like this
Field.GetLength Method
Field.GetLength Method
More like this
FieldLength Method
FieldLength Method
More like this
IField_GetPreviousLength Method
IField_GetPreviousLength Method
More like this
GetPreviousLength_Method.
GetPreviousLength_Method.
More like this