openapi_timeranges.h File Reference

#include "openapi_common.h"

Go to the source code of this file.

Data Structures
struct	OPEN_TIMERANGE_DATE_AND_TIME_s
struct	OPEN_TIMERANGE_PERIODIC_ENTRY_s

Macros
#define	OPEN_TIMERANGE_BUF_LEN   32
#define	OPEN_TIMERANGE_DATE_PARAM_COUNT   3
#define	OPEN_TIMERANGE_DATE_TIME_BUF_LEN   20
#define	OPEN_TIMERANGE_DATE_TIME_PARAM_COUNT   5
#define	OPEN_TIMERANGE_NAME_LEN_MAX   32
#define	OPEN_TIMERANGE_PERIODIC_FREQUENCY_MAX   255
#define	OPEN_TIMERANGE_PERIODIC_FREQUENCY_MIN   0

Typedefs
typedef struct OPEN_TIMERANGE_DATE_AND_TIME_s	OPEN_TIMERANGE_DATE_AND_TIME_t
typedef struct OPEN_TIMERANGE_PERIODIC_ENTRY_s	OPEN_TIMERANGE_PERIODIC_ENTRY_t

Enumerations
enum	OPEN_TIMERANGE_DAILY_t { OPEN_TIMERANGE_EVERY_WEEKDAY = 0, OPEN_TIMERANGE_EVERY_WEEKEND = 1, OPEN_TIMERANGE_EVERY_DAY = 2 }
enum	OPEN_TIMERANGE_DAY_t {   OPEN_TIMERANGE_DAY_SUN = (1 << 1), OPEN_TIMERANGE_DAY_MON = (1 << 2), OPEN_TIMERANGE_DAY_TUE = (1 << 3), OPEN_TIMERANGE_DAY_WED = (1 << 4),   OPEN_TIMERANGE_DAY_THU = (1 << 5), OPEN_TIMERANGE_DAY_FRI = (1 << 6), OPEN_TIMERANGE_DAY_SAT = (1 << 7) }
enum	OPEN_TIMERANGE_PERIODIC_ENTRY_PATTERN_t { OPEN_TIMERANGE_PATTERN_WEEKLY = 0, OPEN_TIMERANGE_PATTERN_DAILY = 1, OPEN_TIMERANGE_PATTERN_MONTHLY = 2 }
enum	OPEN_TIMERANGESTATUS_t { OPEN_TIMERANGE_STATUS_ACTIVE = 1, OPEN_TIMERANGE_STATUS_INACTIVE = 2 }

Functions
open_error_t	openapiTimeRangeAbsoluteEntryEndDateAndTimeAdd (openapiClientHandle_t *client_handle, open_buffdesc *name, open_buffdesc *val)
	Set end date and time for the given absolute time range entry.
open_error_t	openapiTimeRangeAbsoluteEntryEndDateAndTimeGet (openapiClientHandle_t *client_handle, open_buffdesc *name, open_buffdesc *val)
	Get end date and time for the given absolute time range entry.
open_error_t	openapiTimeRangeAbsoluteEntryNumGet (openapiClientHandle_t *client_handle, open_buffdesc *name, uint32_t *val)
	Get the absolute time range entry number for the given time range.
open_error_t	openapiTimeRangeAbsoluteEntryStartDateAndTimeAdd (openapiClientHandle_t *client_handle, open_buffdesc *name, open_buffdesc *val)
	Set start date and time for the given absolute time range entry.
open_error_t	openapiTimeRangeAbsoluteEntryStartDateAndTimeGet (openapiClientHandle_t *client_handle, open_buffdesc *name, open_buffdesc *val)
	Get start date and time for the given absolute time range entry.
open_error_t	openapiTimeRangeAdd (openapiClientHandle_t *client_handle, open_buffdesc *name)
	Creates a time range.
open_error_t	openapiTimeRangeAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *val)
	Get the admin mode of time range.
open_error_t	openapiTimeRangeAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t val)
	Set the admin mode of time range.
open_error_t	openapiTimeRangeCurrNumGet (openapiClientHandle_t *client_handle, uint32_t *val)
	Get the current number of time ranges configured.
open_error_t	openapiTimeRangeDelete (openapiClientHandle_t *client_handle, open_buffdesc *name)
	Deletes a time range.
open_error_t	openapiTimeRangeEntryDelete (openapiClientHandle_t *client_handle, open_buffdesc *name, uint32_t val)
	Remove an entry from an existing time range.
open_error_t	openapiTimeRangeMaxNumGet (openapiClientHandle_t *client_handle, uint32_t *val)
	Get the maximum number of time ranges that can be configured.
open_error_t	openapiTimeRangeNameFirstGet (openapiClientHandle_t *client_handle, open_buffdesc *name)
	Get the first time range created in the system.
open_error_t	openapiTimeRangeNameNextGet (openapiClientHandle_t *client_handle, open_buffdesc *prevName, open_buffdesc *name)
	Get the next time range for the given time range.
open_error_t	openapiTimeRangeNumEntriesGet (openapiClientHandle_t *client_handle, open_buffdesc *name, uint32_t *val)
	Get the current number of entries configures for the specified time range.
open_error_t	openapiTimeRangePeriodicEntryEndDateAndTimeGet (openapiClientHandle_t *client_handle, open_buffdesc *name, uint32_t entry, OPEN_TIMERANGE_PERIODIC_ENTRY_t *val)
	Gets periodic end date and time at which the time range becomes inactive.
open_error_t	openapiTimeRangePeriodicEntryEndDateAndTimeSet (openapiClientHandle_t *client_handle, open_buffdesc *name, uint32_t entry, OPEN_TIMERANGE_PERIODIC_ENTRY_t val)
	Set periodic end date and time at which the time range becomes inactive.
open_error_t	openapiTimeRangePeriodicEntryStartDateAndTimeGet (openapiClientHandle_t *client_handle, open_buffdesc *name, uint32_t entry, OPEN_TIMERANGE_PERIODIC_ENTRY_t *val)
	Gets periodic start date and time at which the time range becomes active.
open_error_t	openapiTimeRangePeriodicEntryStartDateAndTimeSet (openapiClientHandle_t *client_handle, open_buffdesc *name, OPEN_TIMERANGE_PERIODIC_ENTRY_t val)
	Set periodic start date and time at which the time range becomes active.
open_error_t	openapiTimeRangeStatusGet (openapiClientHandle_t *client_handle, open_buffdesc *name, OPEN_TIMERANGESTATUS_t *val)
	Get the status for the given time range.