amarquee.library/FreeQMessage           amarquee.library/FreeQMessage

   NAME
    FreeQMessage - Frees the given QMessage and its associated data.

   SYNOPSIS
    #include 

    void FreeQMessage(struct QSession * session, struct QMessage * qmsg)

   FUNCTION
    Frees the given QMessage and its associated data.  You must call
    this function on EVERY QMessage that you recieve, sometime before
    you QFreeSession the session that you got it from.  After you
    FreeQMessage a QMessage, you may no longer access any of the
    data it contained.  Your app will be more memory efficient if you
    free your QMessages as soon as possible.

   NOTE
    QMessages use a special memory-sharing scheme, so you MUST use
    this function and not FreeMem() or ReplyMsg() or anything else
    on QMessages!

   INPUTS
    session - The session from which you received the QMessage
    qmsg    - The QMessage to free.

   RESULTS
    None.

   EXAMPLE
    struct QSession * s;
    struct QMessage * qmsg;
    
    /* ... setup QSession s ... */
    
    while(qmsg = GetMsg(s->qMsgPort->mp_SigBit))
    {
      /* ... process qmsg ... */
      FreeQMessage(s,qmsg);
    }

   AREXX EXAMPLE
    message = GetNextQMessage(session, -1, 'SIGBREAKF_CTRL_C|SIGBREAKF_CTRL_F')    
    if (message > 0) then do
        say "QMessage received---------"
        say "Status:       " || GetQMessageField(message, 'Status') || " (" || QErrorName(GetQMes
        /* ... */
        call FreeQMessage(session, message)
      end 
    
   SEE ALSO
    QMessages