Definition:

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



aLIBRETURN aStream_CreateSerial(

aIOLib ioRef, const char* pPortName, const unsigned int baudRate, aStreamRef* pStreamRef, aErr* pErr);

Parameters:

ioRef	-	A reference to the aIO library used to create the stream.
pPortName	-	The null-terminated C-style string that designates the serial port to use.  This port name depends on the platform.  The platform-specific port names are listed in the Platform Specifics section of the Overview.
baudRate	-	This number designates at what speed the serial port will run.  The accepted speeds are listed below.
pStreamRef	-	A pointer to a stream reference that is set to the newly created file stream.  Serial port streams are readable and writeable.
pErr	-	A pointer to an aErr variable that receives the error code on exit from this routine.

Return Value:

This library routine returns zero for no errors, and non-zero for errors.

Description:

This routine builds an aStreamRef stream reference object for a specified serial port.  If the port does not exist, an aErrNotFound error occurs.  There are several currently accepted baud rates:
• 2400
• 4800
• 9600
• 19200
• 38400
• 57600
• 115200
If a baud rate is specified that is not available, an aErrRange error occurs.  Serial streams are readable and writeable.  As bytes arrive at the serial port, they are buffered.  When using serial streams, it is your responsibility to keep this buffer from over-running.  Reading from the stream until there are no more bytes available will clear the buffer.  If the buffer is over-run, an aErrOverrun error occurs.

Related:

aStream_Create, aStream_CreateFileInput, aStream_CreateFileOutput, aStream_CreateSocket, aStream_Destroy, aStem_SetStream