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


amarquee.library/QSetParameterOp           amarquee.library/QSetParameterOp

   NAME
    QSetParameterOp - Set miscellaneous parameters.

   SYNOPSIS
    #include 

    LONG QSetParameterOp(struct QSession * session, char * paramName, char * newValue)

   FUNCTION
    This function lets your client set certain environment variables
    or other miscellaneous parameters on the server machine.  Note that 
    your client will need QPRIV_ADMIN status to set most of these variables.
    
   NOTE
    This function requires v45 of amarquee.library, and v1.45
    of AMarqueed.
    
   INPUTS
    session   - The session for which you wish to set a parameter.
    paramName - The keyword corresponding to the parameter you
                wish to set.  Keywords, and who they may be set by,
                are described in this table.
                Note that parameter names are case sensitive!
    newValue  - A NUL-terminated string that is the value you wish 
                to set the given parameter to.
                Values are always passed in ASCII format, even
                for numeric parameters.

   RESULTS
    Returns the assigned ID number of the access operation, or 0
    to indicate failure (due to memory shortage).  

    If you did not have permission to set the parameter you indicated,
    a QERROR_UNPRIVILEGED message will be sent back from the server.

    If you specified an unknown paramName, a QERROR_MALFORMEDKEY
    will be sent back from the server.

   EXAMPLE
    LONG transID;
    
    /* Try to make the server execute a "setenv AMARQUEED_PINGRATE 12"... */ 
    if (transID = QSetParameterOp(session, "AMARQUEED_PINGRATE", "12"))
       printf("Set parameter op succeeded, was given id #%li\n",transID);
    else 
       printf("Set parameter op failed.  (no memory?)\n");

   SEE ALSO
    QGo, QGetParameterOp, QRequestPrivilegeOp
    

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