Knowledge Center Contents Previous Next |
lsb_calendarinfo()
Gets information about calendars defined in the batch system.
DESCRIPTION
lsb_calendarinfo() gets information about calendars defined in the batch system.
On success, this routine returns a pointer to an array of calendarInfoEnt structures which stores the information about the returned calendars and *numCalendars gives number of calendars returned. On failure NULL is returned and lsberrno is set to indicate the error.
In calendarInfoEnt structure:
name
A pointer to the name of the calendar.
desc
A description string associated with the calendar
timeEvents
The time expression list used to generate the time events of the calendar (see bcaladd() for a description of time events and expressions.)
lastEvent
The time of the last event which occurred in the calendar.
lastDuration
The duration of the last time event.
nextEvent
The time of the next event which is expected to occur in the calendar.
nextDuration
The duration of the next time event.
SYNOPSIS
#include <lsf/lsbatch.h> struct calendarInfoEnt *lsb_calendarinfo(char **calendars, int *numCalendars, char *user) struct calendarInfoEnt { char *name; char *desc; char *calExpr; char *userName; int status; int options; int lastDay; int nextDay; time_t creatTime; time_t lastModifyTime; intflags; };PARAMETERS
**calendars
calendars is a pointer to an array of calendar names.
*numCalendars
*numCalendars gives the number of calendar names. If *numCalendars is 0, then information about all calendars is returned. By default, only the invokers calendars are considered.
*user
Setting the user parameter will cause the given users calendars to be considered. Use the reserved user name all to get calendars of all users.
RETURN VALUES
character:POINTER
Sends an array about the calendars and their info .
character:NULL
Function failed.
ERRORS
If the function fails, lsberrno is set to indicate the error.
SEE ALSO
Related APIs
lsb_calendarop()
none
Equivalent line command
none
Files
none
Platform Computing Inc.
www.platform.com |
Knowledge Center Contents Previous Next |