GetNextLength (Method)

IField::GetNextLength

Get the length of the next protected or unprotected field.

Function GetNextLength(cursor As CursorPos, length As Long, [ft As FieldType = UNPROTECTED]) As Long

Parameters

No	Name	Type	Optional	Default	Description
1	cursor	CursorPos	No	-	Position on the screen from where the search starts
2	length	Long	No	-	On success will contain the length of the field in characters. In the case of an error, the contents of this parameter are undefined
3	ft	FieldType	Yes	UNPROTECTED	Get the length of the next PROTECTED or UNPROTECTED field. The default is UNPROTECTED
Return Code			Description
JGS_OK			The field length was found
JGS_PARAMETERERROR			Missing or invalid parameter
JGS_NOTCONNECTED			Your application is not connected to any valid session
JGS_POSITIONERROR			The specified position in the screen is invalid
JGS_SYSERROR			The function failed due to a system error
JGS_NOFIELD			The position was not inside a field, or the screen is unformatted
JGS_ZEROLENFIELD			The specified field has a length of 0

Remarks

This function starts at the specified position. It searches forward for the next PROTECTED or UNPROTECTED field and retrieves it's length.

Sample Code

Dim myPos as CursorPos
Dim myLength as Long
Dim myType as FieldType
Dim result as Long
myPos.row = 18
myPos.column = 45
myType = PROTECTED
result = field.GetNextLength(myPos, myLength, myType)
If result = JGS_OK then
... ' myLength contains length of next protected field
Else ...

Back to IFiend members