COBOL Manual for TNS and TNS/R Programs

Libraries and Utility Routines
HP COBOL Manual for TNS and TNS/R Programs—522555-006
13-138
PUTSTARTUPTEXT
PUTSTARTUPTEXT operates on the saved startup message. The program must have
included a SAVE directive to save the message.
Changing the saved startup message has no effect on the current process. The IN and
OUT files, the other run-command options, and any command-line parameters are
permanently established for a given process by the initialization code that the process
executes before the first statement of the COBOL program. Any process initiated by
the current process after execution of the PUTSTARTUPTEXT routine receives the
changed startup message.
PUTSTARTUPTEXT returns an integer value that indicates the outcome of this
operation. If the startup message does not exist, PUTSTARTUPTEXT attempts to
create one containing the requested text portion and default values for all other
message parts. If this operation fails, a -1, -2, or -3 value is returned. The integer
values and their meanings are:
The startup message creation is successful if both message space and cplist space
are available, and the new message contains the message part requested. All other
message parts are set to their default values. The default values for VOLUME, IN, and
OUT are taken from those of the current program. The default value for the message
parameter string is a null string.
Value Meaning
0 or greater A string of value characters is assigned as the new message part value. If
the file name supplied is all spaces, a 0 is returned for IN or OUT. If the value
supplied is all spaces, a 0 is returned for STRING.
-1 Failure due to a logic error. The message is unchanged. These are possible
logic errors:
•
The portion identifier is not correct or does not identify a defined text part
of the startup message
•
The text string value is not acceptable: there is an illegal system, volume,
or subvolume name; an illegal file name; or a message parameter string
that exceeds 526 characters.
•
The contents of the checkpoint list parameter are inconsistent.
-2 Insufficient checkpoint list space is available to complete the operation. The
message does not change.
-3 Insufficient stack space to create or replace message. The message is
unchanged. Moving large data items from the Working-Storage Section to the
Extended-Storage Section, either manually or with the LARGEDATA directive,
might solve the problem.