CRE Programmer's Guide

Common Language Utility (CLU) Library Functions
Common Run-Time Environment (CRE) Programmer’s Guide—528146-004
9-32
SMU_Startup_GetText_
portion_bytes
is the size of portion, in bytes, and must be a value greater than 0. For TAL, you
must supply this value; for COBOL and FORTRAN, the compiler implicitly
computes and transmits this value to the function. If
portion_bytes exceeds the
number of characters in
portion, the first unused character of portion must be
a space character.
text
is a variable to contain the retrieved text. The function extends the text with blanks
on the right side or truncates it as required to match the size of the variable.
max_text_bytes
is the maximum size of text, in bytes, and must be a non-negative value. For
TAL, you must supply this value, if
text is present; for COBOL and FORTRAN,
the compiler implicitly computes and transmits this value to the function.
Return Value
SMU_Startup_GetText_ returns one of the following values:
VOLUME Retrieves the default volume part. If it includes a system name, the
text appears as follows (maximum 25 characters):
\
system.$volume.subvolume
If it omits a system name, the text appears as follows (maximum 17
characters):
$
volume.subvolume
*ALL* Retrieves the entire startup message as a string (a sequence of
bytes).
Return
Value Meaning
> 0 The operation is successful. The return value gives the length, in bytes, of the
retrieved text before truncation or padding.
-1 The operation failed because of a logic error, such as:
•
portion_bytes or max_text_bytes has an invalid value.
•
The specified startup message does not exist.
•
portion does not identify a defined textual part of the startup message.