NRJERcvMsg [ SNA NRJE User/Programmer Reference Manual ] MPE/iX 5.0 Documentation
SNA NRJE User/Programmer Reference Manual
NRJERcvMsg
Reads one recent host remote console message.
Syntax
___________________________________________________________________________
| |
| D LA I I IA |
| NRJERcvMsg ( ConsoleId, OutBuffer, MaxOutBuf, OutputLength, Result )|
| |
| |
___________________________________________________________________________
Parameters
ConsoleId An input double-word integer variable. The ConsoleId parameter is
the remote host console identification. Obtain the value for this
parameter by calling NRJEConsole before you call this intrinsic.
OutBuffer An output logical array. The OutBuffer array contains the text of a
host remote console message.
OutBuffer is a byte array, and the MaxOutBuf and OutputLength
parameters are byte counts.
NOTE The size of OutBuffer must be large enough to contain a host remote
console message. If OutBuffer is not large enough, the message
will be truncated.
MaxOutBuf An input integer variable. The MaxOutBuf parameter contains the
maximum number of bytes that can be put into OutBuffer. 132 bytes is
recommended.
OutputLength An output integer variable. The OutputLength parameter contains the
actual number of bytes of the host remote console message contained
in OutBuffer.
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 chapter
5.
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
Call NRJERcvMsg to read one recent host console message. Obtain the
ConsoleId by calling NRJEConsole first. Indicate the maximum byte length
of the OutBuffer array in the MaxOutBuf parameter. Obtain the actual
message length from the OutputLength parameter.
While you own the host remote console, you receive all recent host remote
console messages that are directed to your workstation. These messages
may be in response to commands other than those you issued.
Messages will return in the order they are received from the time that
the user opens the console.
Use NRJERcvMsg with the following intrinsics:
* NRJEConsCheck: to determine whether any outstanding console messages
are waiting to be received.
* NRJERelease: to relinquish ownership of the host remote console.
After NRJERcvMsg returns control to your program, test the first element
of Result.
Text Reference
See the SNA NRJE Node Manager's Guide for a description of "Host Console
Commands."
MPE/iX 5.0 Documentation