rd_listschedcodes — Rivendell List Scheduler Codes C Library Function
#include <rivwebcapi/rd_listschedcodes.h>
int RD_ListSchedCodes( | cart[], | |
hostname[], | ||
username[], | ||
passwd[], | ||
ticket[], | ||
user_agent[], | ||
numrecs) ; |
struct rd_schedcodes * cart[]
;const char hostname[]
;const char username[]
;const char passwd[]
;const char ticket[]
;const char user_agent[]
;unsigned * numrecs
;RD_ListSchedCodes is the function to use to list the Scheduler Codes that currently exist in the Rivendell Database.
This function lists the scheduler codes.
Table 1. RD_ListSchedCodes function call fields
FIELD NAME | FIELD TYPE | MEANING | REMARKS |
---|---|---|---|
*schedcodes | Pointer to rd_schedcodes structure | Memory location to store scheduler code 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. |
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_schedcodes structure which is stored in the provided memory locations. The rd_schedcodes structure has the following fields:
struct rd_schedcodes { char code[41]; char description[1021]; }; All character arrays above are the sizes listed and must be null-terminated.