rd_listcuts — Rivendell List Cuts C Library Function
#include <rivwebcapi/rd_listcuts.h>
int RD_ListCuts( | cuts[], | |
hostname[], | ||
username[], | ||
passwd[], | ||
ticket[], | ||
cartnumber, | ||
cutnumber, | ||
user_agent[], | ||
numrecs) ; |
struct rd_cut * cuts[]
;const char hostname[]
;const char username[]
;const char passwd[]
;const char ticket[]
;const unsigned cartnumber
;const unsigned cutnumber
;const char user_agent[]
;unsigned * numrecs
;RD_ListCuts is the function to use to list the cuts that exist in a Rivendell Database Cart entry.
This function lists the fields in the pre-existing cut(s).
Table 1. RD_ListCuts function call fields
FIELD NAME | FIELD TYPE | MEANING | REMARKS |
---|---|---|---|
*cuts | 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 |
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_listcartcuts(7) man page for a listing of the rd_cut structure).