CRE Programmer's Guide
Common Language Utility (CLU) Library Functions
Common Run-Time Environment (CRE) Programmer’s Guide—528146-004
9-31
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.
You cannot delete parts of a startup message, but you can use SMU_Startup_PutText_
to set a STRING message part to a null string. The resultant message image has an
empty parameter string (one with no text) followed by two null characters.
Return Value
SMU_Startup_Delete_ returns one of the following values:
SMU_Startup_GetText_
The SMU_Startup_GetText_ function obtains a specified part of the startup message
as text and assigns it to a string variable.
portion
identifies what you want to retrieve. portion is one of:
Return
Value Meaning
0 The operation is successful.
-1 The operation failed because of a logic error, such as:
•
portion_bytes has an invalid value.
•
portion does not specify a defined deletable part of the startup message.
-2 The operation failed because making changes would invalidate the backup
process.
INT PROC SMU_Startup_GetText_( portion:portion_bytes,
text:max_text_bytes )
EXTENSIBLE;
STRING .EXT portion; ! in, required
INT portion_bytes; ! in, required
STRING .EXT text; ! out, optional
INT max_text_bytes; ! in, optional TNS,native
IN Retrieves the IN file name in external format (maximum 34
characters). The file name can be all blanks.
OUT Retrieves the OUT file name in external format (maximum 34
characters). The file name can be all blanks.
STRING Retrieves the parameter string, not including trailing null characters
(maximum 528 characters).