PPD Variables are references to fields in the Procedure Control Block. The Procedure Control Block is the main control block for a procedure.
The following table describes the PPD predefined variables:
PPDADJ text-following adjustment flag (type=char, length=1, updatable). If PPDADJ has a value of "1" or "2" (see note about INCLUDE at the end of this table), certain lines presented to a command such as SUBMITF will be "adjusted" by prefixing them with a not symbol (^). Lines which will be adjusted are those starting with the two characters "/*", the two characters "/+", the two characters "/&", the four characters "* $$", or the four characters "++/*". In addition, any line already prefixed by either the PPDADJ or PPDSHIFT characters ("^" or "..") will have an additional not symbol (^) added to the beginning of the line. If PPDADJ has a value of "0", adjustment will not occur. PPDADJ is initialized to "0". This facility is provided to convert member text lines which would not be acceptable as BIM-EDIT SYSIN to an innocuous form. See PPDSHIFT for the inverse function.
PPDALARM MAPF audible alarm flag (type=char, length=1, updatable). If PPDALARM has a value of "1", MAPF commands will sound the terminal alarm (that is, beep) when they display. If PPDALARM has a value of "0", the alarm will not be sounded. PPDALARM is intialized to "0".
PPDBLKCT BLOCK command nesting level count used for indexing to the approprate BLOCK location. BLOCK increments the value, ENDBLOCK decrements the value. (type=num, length=5, read only)
PPDCOL column at which variable value matched a search (type=num, length=3, read-only). Initialized to zero. Changed by a successful VEXAMINE command.
PPDCOND conditional execution flag (type=char, length=1, updatable). If PPDCOND has a value of "0", execution of the procedure will be terminated if a command results in a non-OK return code. If PPDCOND has a value of "1", execution will be terminated if a command is rejected (typically for breaking syntax rules), but otherwise control is returned to the procedure. If PPDCOND has a value of "2", control will always be returned to the procedure; if a command would normally be rejected, its return code will be "SV". PPDCOND is initialized to "0".
If PPDCOND is 1 or 2, it is up to the commands which follow the command returning the code to check the SIBRETCD value and act accordingly. If execution of the procedure is terminated due to a non-OK return code or reject when PDCOND is 0 or 1, the error message associated with the error code will be displayed.
PPDCSFLD name of MAPF field to receive cursor (type=char, length=8, updatable). If the value of PPDCSFLD is not the name of a variable attached to an updatable field, MAPF will place the cursor at the upper-leftmost field. Initialized to blanks.
PPDHEX text-following hex flag (type=char, length=1, updatable). If PPDHEX has a value of "1" or "2" (see note about INCLUDE at the end of this table), hex translation will occur on lines encountered in a procedure, including commands and lines processed by a text-following command. If the PPDHEXC character is found in a line, and if the following two characters are valid hex digits, the three characters are converted to the single character having that hexadecimal representation. If PPDHEX has a value of "0", hex translation will not occur. PPDHEX is initialized to "0". This feature is provided to simplify handling of characters which do not have keyboard representations. See "Hexadecimal Display and Editing" in Chapter 6 of the BIM-EDIT User Reference Manual. See also SIBHEXC for hex translation on the command line.
PPDHEXC text-following hex escape character (type=char, length=1, updatable). PPDHEXC is initialized to "@". See PPDHEX.
PPDIFTCT IFTHEN command nesting level count used for indexing to the approprate ENDIF location. IFTHEN increments the value, ENDIF decrements the value (type=num, length=5, read only)
PPDINCL text-following include flag (type=char, length=1, updatable). If PPDINCL has a value of "1" or "2" (see note about INCLUDE at the end of this table), lines beginning with /INCL or )INCL will be treated as INCLUDE commands if they are presented to a command such as SUBMITF. If PPDINCL has a value of "0", /INCL and )INCL will be treated as normal text. PPDINCL is initialized to "0".
PPDKEY MAPF transmission key (type=char, length=5, read-only). PPDKEY is set by a MAPF command to indicate the key which was hit to transmit the screen. It will be "ENTER", "CLEAR", "PF1" through "PF24", or "PA1" through "PA3".
PPDLITDL primary literal delimiter character (type=char, length=1, updatable). Indicates whether apostrophe (') or quote mark (") is the character which will be doubled during value replacement. That is, PPDLITDL modifies the operation of PPDLITEX. Only has effect when set to apostrophe (') or quote mark ("). Initialized to apostrophe.
PPDLITEX literal delimeter expansion control (type=char, length=1, updatable). Indicates how the PPDLITDL character will be expanded when a variable value containing it is replaced into a line. If PPDLITEX is set to "0", no expansion takes place. If PPDLITEX is set to "1", all instances are doubled. If PPDLITEX is set to "2", all instances are quadrupled. Initialized to "0".
PPDLPCTR GOTO and GOSUB loop counter (type=num, length=8, updatable). See the PPDLPLMT description.
PPDLPLMT GOTO and GOSUB loop limit (type=num, length=8, updatable). If a GOTO command which references a LABEL before it in the procedure is encountered, PPDLPCTR is incremented, then compared with PPDLPLMT. If PPDLPCTR is greater than PPDLPLMT, the procedure is terminated. This facility is provided to prevent accidental infinite loops. PPDLPLMT is initialized to 1000.
PPDMSGF MAPF message flag (type=char, length=1, read-only). PPDMSGF is set by a MAPF command to indicate whether any data was entered. If PPDMSGF has a value of "1", some data was entered. If PPDMSGF has a value of "0", no data was entered. PPDMSGF is also set to "0" when CLEAR or a PA key is pressed.
PPDOVBAS text-following overlay column base (type=num, length=3, updatable). PPDOVBAS is used in conjunction with PPDOVLMT and PPDOVSTR. Each line presented to a command such as SUBMITF will be overlayed by the string held in PPDOVSTR at the column range specified by PPDOVBAS and PPDOVLMT. PPDOVBAS and PPDOVLMT should specify a column range no wider than 8 columns. Overlay occurs only if a valid column range is specified. PPDOVBAS and PPDOVLMT are initialized to 0, thus inhibiting overlay processing. PPDOVSTR is initialized to blanks.
PPDOVLMT text-following overlay column limit (type=num, length=3, updatable). See PPDOVBAS.
PPDOVSTR text-following overlay string (type=char, length=8, updatable). See PPDOVBAS.
PPDPFOPT Performance Option. Set to '1' to activate. Duplicate labels may not be used when choosing this option. This option can have significant reduction in procedure run time in procs executing frequent GOTO commands.
PPDPGSIZ printed page size (type=num, length=5, updatable). When running BIM-EDIT in batch utility, a skip to top of page occurs when the current line number exceeds PPDPGSIZ. PPDPGSIZ is initialized to the value of MMPPGSIZ.
PPDPRLIB library name of current procedure (type=char, length=16, read-only).
PPDPRMEM member name of current procedure (type=char, length=16, read-only).
PPDSCRSZ MAPF screen size (type=char, length=1, updatable). If PPDSCRSZ has a value of "D", the default screen size will be used for MAPF. If it has a value of "A", the alternate screen size will be used. The size of "default" and "alternate" can be obtained from SIBSCADP, SIBSCAWD, SIBSCDDP and SIBSCDWD. PPDSCRSZ is initialized to the value of SIBSCRSZ.
PPDSHIFT text-following shift flag (type=char, length=1, updatable). If PPDSHIFT has a value of "1" or "2" (see note about INCLUDE at the end of this table), certain lines presented to a command such as SUBMITF will be shifted left. Lines with a not symbol (^) in column 1 will be shifted left one position, thus deleting the not symbol. Lines with two periods (..) in columns 1 through 2 will be shifted left two positions, thus deleting the two periods. PPDSHIFT is initialized to "0". See PPDADJ for the inverse function.
PPDSPCOL text-following stamp overlay column (type=num, length=3, updatable). PPDSPCOL is used in conjunction with PPDSPFMT. Each line presented to a command such as SUBMITF will be overlayed by member stamp information at the column specified by PPDSPCOL. This feature is provided to allow member stamps to be printed or otherwise processed. The stamp values are not altered.
Stamp overlay occurs only if a valid column and format is specified. PPDSPCOL is initialized to 0, thus inhibiting stamp overlay.
PPDSPFMT text-following stamp overlay format (type=char, length=1, updatable). PPDSPFMT is used in conjunction with PPDSPCOL. Stamp information is formatted as follows, depending upon the value of PPDSPFMT and upon the value of MMPDTCTL:
PPDSPFMT MMPDTCTL="U" MMPDTCTL="I"
1 mmddt ddmmt
2 mmyyt mmyyt
3 uuuut uuuut
4 t,mm/dd/yy,uuuu t,dd/mm/yy,uuuu
5 mmddyyt ddmmyyt
6 mddyuuuu ddmyuuuu
where
dd = day of update
m = month of update (A=October, B=November, C=December)
mm = month of update
y = year of update, last digit only
yy = year of update
t = type of update (A=add, M=modify)
uuuu = first four characters of user id
Stamp overlay occurs only if a valid column and format is specified. PPDSPFMT is initialized to "0", thus inhibiting stamp overlay.
PPDSUBCT GOSUB command nesting level count. Used for RETURN command indexing to the approprate return location from the GOSUB performed subroutine. GOSUB increments the value, RETURN decrements the value. (type=num, length=5, read-only)
PPDTRAP text-following trap flag (type=char, length=1, updatable). If PPDTRAP has a value of "1" or "2" (see note about INCLUDE at the end of this table), lines presented to a command such as SUBMITF will be processed as commands if they begin with the right parentheses ")". If PPDTRAP has a value of "0", lines beginning with right parentheses will be treated as normal text. PPDTRAP is initialized to "0".
PPDTRACE procedure trace flag (type=char, length=1, updatable). If PPDTRACE has a value of "1" every LABEL command will cause a diagnostic message to be written to $LOG. The message will contain the procedure library and member being executed as well as the name of the label.
PPDUTLOG batch utility input log flag (type=char, length=1, updatable). Controls input logging of a Batch Utility execution. "Primary output destination" is the printer if utility is getting its input from batch and is the console if utility is getting its input from the console. PPDUTLOG can assume one of the following values:
0 - Input data and success messages not logged. Error messages
logged to primary output destination.
1 - Input data, success messages, and error messages logged to
primary output destination.
The following are for special situations:
2 - Input data and success messages not logged. Error messages
logged to primary output destination and console.
3 - Input data, success messages, and error messages logged to
primary output destination and console.
Note that when PPDCOND is not "0", an error message will be output like a success message. PPDUTLOG is initialized to "1", so input is normally printed. To avoid printing input, set PPDUTLOG to "0" immediately after the LOGON command.
PPDVBBAS starting column for variable replacement (type=num, length=5, updatable). See description of PPDVBL. PPDVBBAS is initialized to 1.
PPDVBL variable replacement flag (type=char, length=1, updatable). If PPDVBL has a value of "1" or "2" (see note about INCLUDE at the end of this table), &VARNAME will be replaced by the value of of variable VARNAME (if VARNAME is a valid variable name and &VARNAME occurs between the PPDVBBAS column and the PPDVBLMT column) when it is encountered in a procedure. If PPDVBL has a value of "0", variable replacement will not occur. PPDVBL is initialized to "0".
PPDVBLMT ending column for variable replacement (type=num, length=5, updatable). See description of PPDVBL. PPDVBLMT is initialized to 32767.