RD_ListCut
    7
    October 2015
    Rivendell C Library Manual
  
  
    rd_listcut
    Rivendell List Cut C Library Function
  
  
    
      
        Todd
        Baker
        bakert@rfa.org
      
      Rivendell C Library Author
    
  
  
  
    
    #include <rivwebcapi/rd_listcut.h>
    
    int RD_ListCut
       struct rd_cut * cut[]
      const char hostname[]
      const char username[]
      const char passwd[]
      const char ticket[]
      const unsigned cartnumber
      const unsigned cutnumber
      const char user_agent[]
      unsigned * numrecs
     
    
  
  Description
  
    RD_ListCut is  the function to use
    to list the fields within a cut that already exists in the Rivendell Database.
  
  
    This function lists the fields in a pre-existing cut.  
  
  
    RD_ListCut function call fields
    
      
      
      
      
      
        
          
            FIELD NAME
          
          
            FIELD TYPE
          
          
            MEANING
          
          
            REMARKS
          
        
      
      
        
          
            *cut
          
          
          Pointer to rd_cut structure
          
          
            Memory location to store cut information
          
          
            Mandatory
          
        
        
          
            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.
          
        
        
          
            cartnumber
          
          
          unsigned integer
          
          
            Cart Number
          
          
            Mandatory
          
        
        
          
            cutnumber
          
          
          unsigned integer
          
          
            Cut Number
          
          
            Mandatory
          
        
        
          
            user_agent
          
          
          Character Array
          
          
            User Agent Value put into HTTP request
          
          
            Optional (default is Rivendell-C-API/x.x.x)
          
        
        
          
            *numrecs
          
          
          pointer to integer
          
          
            memory location for number of records returned
          
          
            Mandatory
          
        
      
    
  
  
    When successful function will return the number of records sent (numrecs) and a rd_cut structure which 
    is stored in the provided memory locations. (See the
    rd_listcartcuts7 man page
    for a listing of the rd_cut structure).
  
  
  RETURN VALUE
    
      On success, zero is returned. Using the provided parameters an rd_cut
structure is returned and the number of records is returned.
    
    
      If a server error occurs a -1 is returned.
      If a client error occurs a specific error number is returned.
    
  
  ERRORS
    
      400          Missing Cart/Cut Number.
    
    
      403          User Authentification Error.
    
    
      404          No Such Cart/Cut Exists.
    
    
      nnn  Unknown Error Occurred.