RD_DeleteLog
    7
    January 2017
    Rivendell C Library Manual
  
  
    rd_deletelog
    Rivendell Delete Log C Library Function
  
  
    
      
        Todd
        Baker
        bakert@rfa.org
      
      Rivendell C Library Author
    
  
  
  
    
    #include <rivwebcapi/rd_deletelog.h>
    
    int RD_DeleteLog
      const char hostname[]
      const char username[]
      const char passwd[]
      const char ticket[]
      const char log_name[]
      const char user_agent[]
     
    
  
  Description
  
    RD_DeleteLog is  the function to use
    to delete a log from an existing Rivendell Database.
  
  
    This function deletes the specified log from the Rivendell database on hostname.
  
  
    RD_DeleteLog function call fields
    
      
      
      
      
      
        
          
            FIELD NAME
          
          
            FIELD TYPE
          
          
            MEANING
          
          
            REMARKS
          
        
      
      
        
          
            hostname
          
          
          Character Array
          
          
            Name Of Rivendell DB Host
          
          
            Mandatory
          
        
        
          
            username
          
          
          Character Array
          
          
            Rivendell User Name
          
          
            Mandatory When NO Ticket Provided
          
        
        
          
            passwd
          
          
          Character Array
          
          
            Rivendell User Password
          
          
            Mandatory When NO Ticket Provided
          
        
        
          
            ticket
          
          
          Character Array
          
          
            Rivendell Authentification Ticket
          
          
            Mandatory When NO User/Password Pair Provided.
          
        
        
          
            log_name
          
          
          Character Array
          
          
            Name of log to delete
          
          
            Mandatory
          
        
        
          
            user_agent
          
          
          Character Array
          
          
            User Agent Value put into HTTP request
          
          
            Optional (default is Rivendell-C-API/x.x.x)
          
        
      
    
  
  
  RETURN VALUE
    
      On success, zero is returned.
    
    
      If a server error occurs a -1 is returned.
      If a client error occurs a specific error number is returned.
    
  
  ERRORS
    
      400          Invalid/Missing Parameter for LOG_NAME.
    
    
      403          User Authentification Error.
    
    
      404          User Permissions Error.
    
    
      500          Unable to Delete Log.
    
    
      nnn  Unknown Error Occurred.