HP 3000 Manuals

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

VGETKEYLABELS 

Retrieves global or current form function key labels.

Syntax 

             VGETKEYLABELS {comarea,formorglob,numoflabels,labels}

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
                 VGETKEYLABELS:

                 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.

                 VGETKEYLABELS may set the following comarea item:

                 cstatus          Set to nonzero value if call
                                  unsuccessful.

formorglob       Two-byte integer specifying which type of labels are to
                 be retrieved.

                   0 - Retrieve global labels
                   1 - Retrieve current form labels

numoflabels      Two-byte integer indicating how many labels are to be
                 retrieved.  This value must be from 1 to 8, inclusive.

labels           A byte array in which the labels are passed back to an
                 application.  The length of the array must be at least
                 numoflabels * 16.  (Each label is 16 bytes long.)

Discussion 

This intrinsic is used to copy global or current form function key labels
that have been specified with FORMSPEC, VSETKEYLABEL, or VSETKEYLABELS
into an application.  Labels for some or for all eight function keys can
be copy.  The labeloption must be set to one prior to VOPENFORMF.

When this intrinsic is called, any active labels are retrieved from the
key label buffers in memory into an application.  If there are no active
labels, a buffer of spaces is returned.  The labels are displayed by
calling VSHOWFORM.

Example 

COBOL

     77 FORM-OR-GLOB     PIC S9(4)COMP.
     77 NUM-OF-LABELS    PIC S9(4)COMP.
     77 KEY-LABELS       PIC X(32).
         :
     MOVE 1 TO FORM-OR-GLOB.
     MOVE 2 TO NUM-OF-LABELS.
     CALL "VGETKEYLABELS" USING COMAREA,FORM-OR-GLOB,NUM-OF-LABELS,KEY-LABELS.

     BASIC
     10 INTEGER F,N
     20 DIM L$[32]
     30 F=1
     40 N=2
     50 CALL VGETKEYLABELS(C[*],F,N,L$)

     FORTRAN
     CHARACTER*32 LABELS
     INTEGER*2 FORMORGLOB,NUMLABELS
     FORMORGLOB=1
     NUMLABELS=2
     CALL VGETKEYLABELS(COMAREA,FORMORGLOB,NUMLABELS,LABELS)

     SPL/PASCAL
     INTEGER
        FORM'OR'GLOB,
        NUM'OF'LABELS;
     BYTE ARRAY
        LABELS(0:31);
        :
     FORA'OR'GLOB: =1;
     NUM'OF'LABELS:=2;
     VGETKEYLABELS(COMAREA,FORM'OR'GLOB,NUM'OF'LABELS,LABELS);

MPE/iX 5.0 Documentation