[Contents] [Index] [Help] [Browse <] [Browse >]


amarquee.library/QClearSubscriptionOp           amarquee.library/QClearSubscriptionOp

   NAME
    QClearSubscriptionOp - Remove a subscription or all your subscriptions

   SYNOPSIS
    #include 

    LONG QClearSubscriptionsOp(struct QSession * session, LONG which)

   FUNCTION
    This function may be used to tell the AMarquee server that you wish
    to remove one or all of your current subscriptions.
    
   NOTE
    No error will be returned, and no harm done, if you specify the
    deletion of a subscription id that you do not have in effect.
    
   INPUTS
    session - The session that you wish to send the clearsubscription op to.
    which   - The transaction ID of the subscription to clear (as was
              returned to you by QSubscribeOp), or 0 if you wish to
              clear all of your current subscriptions.
              
   RESULTS
    Returns the assigned ID number of the clearsubscription operation
    on success, or 0 on failure.
   
   EXAMPLE
    LONG transID;

    /* clear all our previous subscriptions */
    if (transID = QClearSubscriptionsOp(session, 0))
       printf("ClearSub op succeeded, was given id #%li\n",transID);
    else 
       printf("ClearSub op failed.  (no memory?)\n");
    
   AREXX NOTES
    In ARexx, the second argument is optional.  If not specified,
    it defaults to zero (e.g. clear all subscriptions)

   AREXX EXAMPLE
    transID = QClearSubscriptionsOp(session)
    if (transID = 0) then say "Oops, transaction failed."

   SEE ALSO
    QGo, QSubscribeOp
    

Converted on 24 Mar 2002 with RexxDoesAmigaGuide2HTML 2.1e(private) by Michael Ranner.