CRE Programmer's Guide

Common Language Utility (CLU) Library Functions
Common Run-Time Environment (CRE) Programmer’s Guide—528146-004
9-34
SMU Function Considerations
text_bytes
is the size of text, in bytes, and must be a non-negative value. For TAL, you must
supply this value; for COBOL and FORTRAN, the compiler implicitly computes and
transmits this value to the function.
If the startup message exists, the function assigns
text as the message part. If the
startup message does not exist, the function creates it, assigns
text as the message
part, and assigns default values to the other message parts. In either case, the function
truncates any trailing blanks in the supplied text before assigning it.
Return Value
SMU_Startup_PutText_ returns one of the following values:
SMU Function Considerations
The remainder of this section gives SMU function considerations for COBOL,
FORTRAN, TAL, and pTAL.
VOLUME The text is the new default volume part. If it includes a system
name, the text must have the following format (maximum 25
characters):
\
system.$volume.subvolume
If it does not include a system name, the text must have the
following format (maximum 17 characters):
$
volume.subvolume
Return
Value Meaning
0 The operation is successful; a null string is assigned.
> 0 The operation is successful. The return value gives the length, in bytes, of the
assigned text after blank truncation.
-1 The operation failed because of a logic error, such as:
•
portion_bytes or text_bytes has an invalid value.
•
portion does not identify a defined textual part of the startup message.
•
The text is invalid for the message part (invalid volume, invalid file name, or a
parameter string longer than 528 characters).
-2 The operation failed because making changes would invalidate the backup
process.
-3 The environment has insufficient allocatable space to complete the operation.