SNA NRJE User/Programmer Reference Manual (30292-90006)

170 Chapter5
User Intrinsics
NRJEWelcome
NRJEWelcome
Obtains the contents of the NRJE welcome message.
Syntax
I I BA IA
NRJEWelcome ( MaxLen , ActLen , Msg , Result )
Parameters
MaxLen An input integer variable. The MaxLen parameter
specifies the maximum text length that can be returned
in
Msg .
The maximum length of the NRJE welcome message is
1912 characters. (This includes the carriage return and
the line feed.)
ActLen An output integer variable. The ActLen parameter
contains the actual number of characters of the NRJE
welcome message returned to you in the
Msg array.
Msg An output byte array. The Msg array contains the
text of the NRJE welcome message.
Result An eight-element integer output array (required).
The
Result array contains error codes that occurred
during execution of this intrinsic.
The first element of the Result array is set to zero if no
errors took place. The structure of the
Result array is
described in “Parameters Common to NRJE Intrinsics”
in the introduction to this chapter.
Always test the first element of
Result immediately
after you call this intrinsic. If the first element of
Result is not zero, test the other elements of Result to
determine the nature of the problem that has occurred.
Description
NRJEWelcome is used to obtain the text of an NRJE welcome message.
You must provide an array large enough to hold all of the welcome
message text. Specify the message array size when you call
NRJEWelcome. NRJE can accept lines up to 80 characters long and adds
a carriage return and a line feed at the end of each line. The maximum
total number of characters that can be included in the welcome file is
1912. The actual message length is returned by the intrinsic. When
NRJEWelcome returns control to your program, you should test
Result .