FORTRAN Reference Manual

Utility Routines
FORTRAN Reference Manual—528615-001
15-51
PUTSTARTUPTEXT Routine
Considerations
•
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.
•
Text values for PUTSTARTUPTEXT
If you specify 'VOLUME', text contains the default node, volume, and subvolume
names, formatted as:
\node.$volume.subvol
and contains a maximum of 25 characters. If the volume part does not include the
node name component, text is just $volume.subvol.
If you specify 'IN', text contains the input file name and can have a maximum of
34 characters. The file name can be all blanks.
If you specify 'OUT', text is the output file name and can have a maximum of 34
characters. The file name can be all blanks.
If you specify 'STRING', text contains the startup message’s parameter string, not
including trailing null characters, and can have a maximum of 526 characters. You
can use a RECORD name for text to circumvent the limit of 255 characters for
the length of a character variable.
•
Results returned for PUTSTARTUPTEXT
Return Value Meaning
≥0 A non-negative value (zero or positive integer) indicates a string of
that many characters is replaced as the new message part value.
For IN or OUT, if the file name supplied is all blanks, a zero is
returned. For STRING, if the value supplied is all blanks, a zero is
returned.
-1 Indicates a failure due to a logic error. The message is unchanged.
Possible logic errors are:
•
The portion value is not correct or does not identify a defined
part of the startup message.
•
The text string value is not acceptable The node name, volume
name, subvolume name, or file name is illegal; or you specified
an unknown node name or a message parameter string exceeds
526 characters.
•
The contents of cplist are inconsistent.
-2 Indicates insufficient checkpoint list space to complete the operation.
The message is unchanged.
-3 Indicates insufficient message storage space to complete the
operation. The message is unchanged.