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


amarquee.library/QDeleteOp           amarquee.library/QDeleteOp

   NAME
    QDeleteOp - Delete the given set of entries from the Amarquee server.

   SYNOPSIS
    #include 

    LONG QDeleteOp(struct QSession * session, char * wildpath)

   FUNCTION
    This function tells the AMarquee server to remove and free
    the entries stored in wildpath.
    
    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 a QMessage with
    qm_Data equal to NULL.

   NOTE
    You may only remove entries in your own directory.  Attempting
    to remove other people's data will result in you being sent
    a QERROR_UNPRIVILEGED error QMessage.

    This function will also immediately delete any streaming
    buffers that were created for the given node(s) via QStreamOp.
    To ensure that all stream updates were received, you may
    want to do a QGo(QGOF_SYNC) and wait for the returned
    sync QMessage before QDeleteOp'ing the node(s).
    
   INPUTS
    session  - The session to send the delete op to.
    wildpath - The path of the data items you wish to remove.
               You may include wildcards to remove multiple items.
    
   RESULTS
    Returns the assigned ID number of the delete operation on success,
    or 0 on failure.  Any server-side errors will be sent asynchronously
    as QMessages.
   
   EXAMPLE
    LONG transID;
    
    if (transID = QDeleteOp(session, "myNode"))
       printf("Delete op succeeded, was given id #%li\n",transID);
    else 
       printf("Delete op failed.  (no memory?)\n");

   AREXX EXAMPLE
    transID = QDeleteOp(session, 'myNode')
    if (transID = 0) then say "Oops, operation failed"

   SEE ALSO
    QGo
    

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