HP 3000 Manuals

USING VPLUS/V INTRINSICS [ HP Data Entry and Forms Management System (VPLUS/V) ] MPE/iX 5.0 Documentation


HP Data Entry and Forms Management System (VPLUS/V)

Chapter 6  USING VPLUS/V INTRINSICS 

USING VPLUS/V INTRINSICS 

A set of callable intrinsics is provided by VPLUS/V. Table 6-1 lists the
VPLUS/V intrinsics in alphabetic order and summarizes their functions.  A
full description of each intrinsic appears later in this section.  They
can be used by any application, either for data entry or for other
terminal related applications.  The VPLUS/V intrinsics manage the
interface between an application, the terminal, a forms file, the entered
data, and, optionally, the batch file to which entered data may be
written.  These intrinsics are used by the VPLUS/V Data Entry Program
(ENTRY) to control data entry.

Appendix A contains listings in different programming languages of sample
applications.  These listings provide useful examples of how to use the
VPLUS/V intrinsics.

Multipurpose 

The VPLUS/V intrinsics can be called by any application that displays
forms on a terminal supported by VPLUS/V. With the exception of the batch
file management intrinsics used specifically for data entry, the VPLUS/V
intrinsics can be used in conjunction with FORMSPEC to allow for data
base inquiries and updates via the application, as well as any other
operation that results in the display or collection of data through a
terminal form.  Such applications can also make use of the capabilities
that VPLUS/V provides for validating input data.

Multilanguage 

The VPLUS/V intrinsics can be called from programs written in any of the
supported programming languages listed in Appendix A. Additionally, some
languages (also listed in Appendix A) provide the programmer with a
special interface with terminals and forms, as described in their
respective reference manuals.  With these languages, the programmer does
not call the VPLUS/V intrinsics directly.  Instead, the programmer
specifies the statements appropriate to the special interface.  Each of
the supported programming languages calls the VPLUS/V intrinsics with the
same parameters, and these parameters are essentially the same type and
size.  So that the intrinsics can adjust to any peculiarities of the
calling programming language, one input sub-parameter specifies the
language of the calling program.

Error Detection 

If a system or program error causes a VPLUS/V intrinsic to fail, an error
code is returned to the calling program.  Once an error has been
detected, subsequent intrinsic calls do not perform any functions until
the program detects the error and performs its own error routine.  In
order for processing to continue after an error is detected, the calling
program must reset the error argument.  This method of error handling
means that intrinsic errors do not cause unexpected program termination.

          Table 6-1.  Summary of VPLUS/V Intrinsics 

--------------------------------------------------------------------------------------------
|                       |                                                                  |
|       INTRINSIC       |                             FUNCTION                             |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VCHANGEFIELD          | Changes field attributes for specified fields at run-time.       |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VCLOSEBATCH           | Closes batch file.                                               |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VCLOSEFORMF           | Closes forms file.                                               |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VCLOSETERM            | Closes terminal file.                                            |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VERRMSG               | Returns message associated with error code.                      |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VFIELDEDITS           | Performs field phase processing specifications.                  |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VFINISHFORM           | Performs final phase processing specified for form.              |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VGETBUFFER            | Copies contents of data buffer into application.                 |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VGETFIELD             | Copies field contents from data buffer into application.         |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VGETFIELDINFO         | Returns field information.                                       |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VGETFILEINFO          | Returns forms file information.                                  |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VGETFORMINFO          | Returns form information.                                        |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VGETKEYLABELS         | Returns global or form function key labels.                      |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VGETLANG              | Returns the native language ID of the forms file being executed. |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VGETNEXTFORM          | Reads next form into form definition area of memory; window and  |
|                       | data buffer are not affected.                                    |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VGETtype              | Copies field contents from data buffer to application,           |
|                       | converting data to specified type.                               |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VINITFORM             | Sets data buffer to initial values for form.                     |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VLOADFORMS            | Loads the specified forms into terminal local form storage       |
|                       | memory.                                                          |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VOPENBATCH            | Opens batch file for processing.                                 |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VOPENFORMF            | Opens forms file for processing.                                 |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VOPENTERM             | Opens terminal file for processing.                              |
|                       |                                                                  |
--------------------------------------------------------------------------------------------

          Table 6-1.  Summary of VPLUS/V Intrinsics (cont.) 

--------------------------------------------------------------------------------------------
|                       |                                                                  |
|       INTRINSIC       |                             FUNCTION                             |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VPLACECURSOR          | Positions the cursor at a specified field after a form is        |
|                       | displayed.                                                       |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VPOSTBATCH            | Updates end of file mark in batch file after last record         |
|                       | referenced.                                                      |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VPRINTFORM            | Prints current form and data buffer on offline list device.      |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VPRINTSCREEN          | Prints entire contents of screen on offline list device.         |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VPUTBUFFER            | Copies data from application to data buffer.                     |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VPUTFIELD             | Copies data from application to field in data buffer.            |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VPUTtype              | Copies data of specified type from application to data buffer,   |
|                       | converting data to external format.                              |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VPUTWINDOW            | Copies message from application to window area in memory for     |
|                       | later display.                                                   |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VREADBATCH            | Reads record from batch file into data buffer.                   |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VREADFIELDS           | Reads input from terminal into data buffer.                      |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VSETERROR             | Sets error flag for data field in error and copies error message |
|                       | to window area.                                                  |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VSETKEYLABEL          | Temporarily sets a new label for a function key.                 |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VSETKEYLABELS         | Temporarily sets new labels for function keys.                   |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VSETLANG              | Specifies the native language ID to be used with an              |
|                       | international forms file.                                        |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VSHOWFORM             | Updates terminal screen, merging the current form, any data in   |
|                       | buffer, any key labels, and any message in window.               |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VUNLOADFORM           | Unloads a specified form from terminal local form storage        |
|                       | memory.                                                          |
|                       |                                                                  |
--------------------------------------------------------------------------------------------
|                       |                                                                  |
| VWRITEBATCH           | Writes data from data buffer to batch file.                      |
|                       |                                                                  |
--------------------------------------------------------------------------------------------



MPE/iX 5.0 Documentation