Definition:

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



aLIBRETURN aPacket_Destroy(

aStemLib stemRef, aPacketRef packetRef, aErr* pErr);

Parameters:

stemRef	-	A pointer to the opaque library reference used to destroy the packet.
packetRef	-	This packet to destroy.
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 destroys a aPacketRef reference and any associated resources.  This routine should be called on every aPacketRef retrieved with the aStem_GetPacket routine.  This routine need not be called on packets that are sent using the aStem_SendPacket routine as this routine manages the destruction after sending the packet data.

Related:

aPacket_Create, aPacket_GetData, aStem_SendPacket, aStem_GetPacket