HP Data Entry and Forms Management System (VPLUS) Reference Manual (32209-90024)

Chapter 6 297
USING VPLUS INTRINSICS
INTRINSIC DESCRIPTIONS
VGETSCPDATA
Returns information about the cursor position by field number and row and column on a
VPLUS screen.
Syntax
VGETSCPFIELD { comarea,fieldnum,screenrow,screencol }
Parameters
comarea Must be comarea name specified when the forms file was opened with
VOPENFORMF. If not already set, the following comarea items must be set
before calling VARMSCP:
cstatus Set to zero.
comarealen Set to total number of two-byte words in comarea. Must be
at least 70 words in length.
fieldnum Two-byte integer variable to which VGETSCPFIELD returns the field
number of the field where the cursor was last positioned when the read
terminated.
screenrow Two-byte integer variable to which VGETSCPDATA returns the physical row
number on the screen where the cursor was last positioned when the read
terminated.
screencol Two-byte integer variable to which VGETSCPDATA returns the physical
column number on the screen where the cursor was last positioned when
the read terminated.
Discussion
When VREADFIELDS terminates, the cursor position on the screen is tracked and retrieved
by VGETSCPFIELD. The information contains the field number of the field in which the
cursor was positioned when the read was terminated. No cursor position information is
available if a VREADFIELDS retry occurs.
VGETSCPDATA returns the physical position of the cursor on the screen by row and column
number. Rows are numbered from top to bottom and columns are numbered from left to
right.
NOTE The row and column information returned by VGETSCPDATA is raw physical
information and may not directly correspond to actual elements of the user
interface.
Like VGETSCPFIELD, VGETSCPDATA returns a -1 in fieldnum if:
• The cursor was not positioned within a field when the read terminated.
• No cursor position information is available when VGETSCPDATA is called.
• The cursor is positioned within a multi-line field and beyond the first line of the field.
VGETSCPDATA should be called after each VREADFIELDS since it first retrieves the cursor