VBS_GetLength (Menthod)

IField::VBS_GetLength

Get the length of the specified field.

Function VBS_GetLength(row As Variant, column As Variant, length As Variant) As Long

Parameters

No	Name	Type	Optional	Default	Description
1	row	Variant	No	-	screen row inside the field for which to retrieve the length
2	column	Variant	No	-	screen column inside the field for which to retrieve the length
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 argument are undefined
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

Sample Code

Dim row as Variant
Dim column as Variant
Dim fieldLength as Variant
Dim result as Long
row = 18
column = 45
result = field.VBS_GetLength(row, column, fieldLength)
If result = JGS_OK then
... ' fieldLength contains length of field
Else ...

Back to IField members