Definition:

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



aLIBRETURN aPacket_Format(

aStemLib stemRef, const aPacketRef packetRef, char* pBuffer, const unsigned short nMaxLength, aErr* pErr);

Parameters:

stemRef	-	A pointer to the opaque stem reference used to manage the packet formatting.
packetRef	-	This packet to format the string for.
pBuffer	-	A pointer to a char buffer that is to receive the formatted packet .
nMaxLength	-	The maximum number of buffer characters to be filled.
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 formats a aPacketRef object as a NULL-terminated C-style string.  The size of the pBuffer parameter must be at least nMaxLength bytes long to ensure the buffer is not over-run when formatting the packet.  The first character of the packet is a < or > that represents whether the packet was from the stem (<) or the host (>).  The next byte is a hexidecimal number that is the to/from address of the packet.  The next character is a ":" and finally, the data bytes are shown in hexidecimal.

Related:

aStem_GetPacket, aPacket_Create