VBS_GetPreviousLength (Method)

IField::VBS_GetPreviousLength

Get the length of the previous protected or unprotected field.

Function VBS_GetPreviousLength(row As Variant, column As Variant, length As Variant, [ft As FieldType = UNPROTECTED]) As Long

Parameters

No	Name	Type	Optional	Default	Description
1	row	Variant	No	-	Position on the screen from where the search starts
2	column	Variant	No	-
3	length	Variant	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
4	ft	FieldType	Yes	UNPROTECTED	Get the length of the previous 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 backward for the next PROTECTED or UNPROTECTED field and retrieves it's length.

Sample Code

Dim row as Variant
Dim column as Variant
Dim myLength as Variant
Dim myType as FieldType
Dim result as Long
row = 18
column = 45
myType = PROTECTED
result = field.VBS_GetPreviousLength(row, column, myLength, myType)
If result = JGS_OK then
... ' myLength contains length of previous protected field
Else ...

Back to IField members