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


amarquee.library/QKillClientsOp           amarquee.library/QKillClientsOp

   NAME
    QKillClientsOp - Cause other clients to be disconnected from the server.

   SYNOPSIS
    #include 

    LONG QKillClientsOp(struct QSession * session, char * hosts)

   FUNCTION
    With this function you can forcibly remove the AMarqueed connections
    from other client programs that are logged in to the same server.
    This function is intended to be used by administration programs
    only, and thus it requires special permission to use.

   NOTE
    This function requires v45 of amarquee.library, and v1.45
    of AMarqueed.

    This command will never cause your own client to be disconnected,
    even if your /hostName/progName is included in the hosts argument's
    specification.
        
   INPUTS
    session   - The session on which you wish to kill other clients.
    hosts     - A hostname specifier describing which hosts and/or
                programs should be disconnected.  This should be a
                string in the form of "/hostExp/progExp".
                
   RESULTS
    Returns the assigned ID number of the access operation, or 0
    to indicate failure (due to memory shortage, or because the
    hosts string was not formatted correctly).  
    
    If you do not have QPRIV_KILLCLIENTS permission, this command
    will have no effect other than to have a QERROR_UNPRIVILEGED
    packet be sent to you.
    
   EXAMPLE
    LONG transID;
    
    /* Disconnect all clients except my own */
    if (transID = QKillClientsOp(session, "/#?/#?"))
       printf("KillClients op succeeded, was given id #%li\n",transID);
    else 
       printf("KillClients op failed.  (no memory?)\n");

   AREXX EXAMPLE
    transID = QKillClientsOp(session, '/#?/#?')
    if (transID = 0) then say "Oops, transaction failed."

   SEE ALSO
    QGo, QRequestPrivilegesOp, QReleasePrivilegesOp
    

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