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

Chapter 6 295
USING VPLUS INTRINSICS
INTRINSIC DESCRIPTIONS
VGETSAVEFIELD
Copies contents of the specified save field from save field buffer in memory to an
application.
Syntax
VGETSAVEFIELD {c
omarea,sfname,sfbuf,buflen,actualen
}
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 VGETSAVEFIELD:
cstatus set to zero.
language set to the code identifying the programming language of
the calling program.
comarealen set to total number of two-byte words in
comarea
. Must be
at least 70 words in length.
VGETSAVEFIELD may set the following
comarea
item:
cstatus set to nonzero value if call is unsuccessful.
sfname is a character string in the application which contains the name of the
save field.
sfbuf is a character string in the application to which the contents of the save
field is copied.
buflen is a two-byte integer variable which specifies the number of bytes in
sfbuf
.
actualen is a two-byte integer variable which specifies the number of bytes actually
moved to
sfbuf
.
Discussion
VGETSAVEFIELD transfers the contents of the save field specified by
sfname
to a variable in
an application.
If the number of bytes specified by
buflen
is less than the length of the save field, the right
most bytes are truncated. Following a successful transfer,
actualen
is set to the actual
number of bytes transferred to
sfbuf
.
VGETSAVEFIELD does not convert the data moved to the application variable.