FORTRAN Reference Manual

Utility Routines
FORTRAN Reference Manual—528615-001
15-42
GETPARAMTEXT Routine
Example
?GUARDIAN GETBACKUPCPU
INTEGER existcpu
existcpu = GETBACKCPU ()
GETPARAMTEXT Routine
The GETPARAMTEXT routine obtains a specified part of the PARAM message as text
and assigns it to a string variable. The assignment is done according to the FORTRAN
rules for a CHARACTER variable assignment.
result
is an integer variable in which GETPARAMTEXT returns the result of the
operation. See Considerations.
portion
is a character expression that identifies the particular part of the message to
retrieve. The string value must be a legal parameter name for the PARAM
message. The first unused character position in portion, if any, must be a blank.
Any characters including and following a blank are ignored.
You can specify '*ALL*' for portion to obtain the entire PARAM message. See
Considerations.
text
is the character variable or RECORD into which the retrieved message text is
placed. The text returned from a specific PARAM message parameter is the value
associated with that parameter name.
Considerations
•
Values returned by GETPARAMTEXT
result = GETPARAMTEXT ( portion, text )
Return Value Meaning
≥0 Indicates a string of result characters, before truncation or
padding, is returned to text. If the parameter value is a null
string, a zero is returned.
-1 Indicates a failure due to a logic error, nothing is returned in
text. Possible logic errors are:
•
The PARAM message does not exist.
•
portion is not correct or identifies a parameter that
does not exist in the PARAM message.