FORTRAN Reference Manual

Utility Routines
FORTRAN Reference Manual—528615-001
15-44
GETSTARTUPTEXT Routine
text
is a character variable or RECORD into which the retrieved message text is
placed. See Considerations.
Considerations
•
Values returned by GETSTARTUPTEXT
•
Text values for GETSTARTUPTEXT
If you specify 'VOLUME', text contains the default node, volume, and subvolume
names, formatted as
\ node.$ volume. subvol
and can have a maximum of 25 characters. If the volume part does not include the
node name component, text contains $volume. subvol.
If you specify 'IN', text is the input file name and can have a maximum of 34
characters. The name can be all blanks.
If you specify 'OUT', text is the output file name and can have a maximum of 34
characters. The name can be all blanks.
If you specify 'STRING', text is the startup message’s parameter string, not
including trailing null characters. It can be a maximum of 526 characters. You can
use a RECORD name as text to circumvent the limit of 255 characters for a
character variable.
Example
?GUARDIAN GETSTARTUPTEXT
INTEGER error
CHARACTER * 25 old volume
error = GETSTARTUPTEXT ('VOLUME', old volume)
Return Value Meaning
≥0 A non-negative value (zero or positive integer) indicates a string of
that many characters, before truncation or padding, is returned to
text. For IN or OUT, if the file name is all blanks, a zero is
returned. For STRING, if the value is a null string, a zero is
returned.
-1 Indicates a failure due to a logic error; nothing is assigned to text.
Possible logic errors are:
•
The startup message does not exist.
•
The portion value is not correct or does not identify a defined
part of the startup message.