amarquee.library/QPingOp           amarquee.library/QPingOp

   NAME
    QPingOp - Requests that the Amarquee server respond with a
              "ping" message.

   SYNOPSIS
    #include 

    LONG QPingOp(struct QSession * session)

   FUNCTION
    This function tells the AMarquee server to return a ping QMessage.
    This can be useful if you wish to be sure that your AMarquee process
    has completed all previous operations you may have sent it.

    This function may also be used in direct client-to-client
    connections (as created via QNewSession and QNewHostSession),
    in which case the other client will receive an QMessage containing
    how much memory is free on your machine.
    
   NOTE
    While this operation will help you synchronize to the completion
    of work by your *own* AMarqueed server process, it will not 
    guarantee that by the time you receive your "ping" QMessage,
    that your changes have been propagated to all the *other* AMarqueed
    processes.  You can use QGo(QGOF_SYNC)'s ping reply to guarantee that.
     
   INPUTS
    session - The session to send the ping operation to.
    
   RESULTS
    Returns the assigned ID number of the ping operation or 0 to
    indicate failure.  A ping QMessage will be returned asynchronously.

   EXAMPLE
    LONG transID;
    
    /* Send a ping to the server, that will be sent back ASAP */
    if (transID = QPingOp(session))
       printf("Ping op succeeded, was given id #%li\n",transID);
    else 
       printf("Ping op failed.  (no memory?)\n");

   AREXX EXAMPLE
    transID = QPingOp(session)
    if (transID = 0) then say "Oops, transaction failed."
    
   SEE ALSO
    QGo, QInfoOp