Definition:

#include <aStem.h>
object code: aStem shared library



aLIBRETURN aStem_CreateRelayStream(

aStemLib stemRef, const unsigned char nAddress, aStreamRef pStreamRef, aErr* pErr);

Parameters:

stemRef	-	A pointer to the opaque stem reference used for sending the packet.
nAddress	-	The address of the module that will be connected to the stream.
pStreamRef	-	A pointer to the aStreamRef that will be filled in by this routine for communicating with the requested module's serial port.
pErr	-	A pointer to an aErr variable that recieves the error code on exit from this routine.

Return Value:

This library routine returns an aLIBRETURN type that is non-zero if there are errors, and zero if the routine completes with no errors.

Description:

This routine creates a virtual serial port connection through the router allowing you to use the serial ports of slave modules that are not being used for other purposes.  The slave module must be properly set up using the cmdVAL_SET and cmdVAL_SAV commands to properly route the serial traffic to the stream created by this routine.

Related:

aStream_Read, aStream_Write, aStream_ReadLine, aStream_WriteLine, aStream_Destroy, aStem_ReleaseLibRef