Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Data Structures | |
struct | OPEN_TIMERANGE_DATE_AND_TIME_s |
struct | OPEN_TIMERANGE_PERIODIC_ENTRY_s |
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 |
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.
[in] | client_handle | client handle from registration API |
[in] | name | time range name |
[in] | val | date and time (year-month-day hours:minutes) |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | name | time range name |
[out] | val | date and time (year-month-day hours:minutes) |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | name | time range name |
[out] | val | entry number |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | name | time range name |
[in] | val | date and time (year-month-day hours:minutes) |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | name | time range name |
[out] | val | date and time (year-month-day hours:minutes) |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiTimeRangeAdd | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | name | ||
) |
Creates a time range.
[in] | client_handle | client handle from registration API |
[in] | name | time range name |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiTimeRangeAdminModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t * | val | ||
) |
Get the admin mode of time range.
[in] | client_handle | client handle from registration API |
[out] | val | time range admin mode |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiTimeRangeAdminModeSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t | val | ||
) |
Set the admin mode of time range.
[in] | client_handle | client handle from registration API |
[in] | val | time range admin mode |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiTimeRangeCurrNumGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | val | ||
) |
Get the current number of time ranges configured.
[in] | client_handle | client handle from registration API |
[out] | val | number of time ranges |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiTimeRangeDelete | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | name | ||
) |
Deletes a time range.
[in] | client_handle | client handle from registration API |
[in] | name | time range name |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiTimeRangeEntryDelete | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | name, | ||
uint32_t | val | ||
) |
Remove an entry from an existing time range.
[in] | client_handle | client handle from registration API |
[in] | name | time range name |
[in] | val | time range entry ID created on adding absolute or periodic time range entry |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiTimeRangeMaxNumGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | val | ||
) |
Get the maximum number of time ranges that can be configured.
[in] | client_handle | client handle from registration API |
[out] | val | number of time ranges |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiTimeRangeNameFirstGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | name | ||
) |
Get the first time range created in the system.
[in] | client_handle | client handle from registration API |
[out] | name | time range name |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiTimeRangeNameNextGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | prevName, | ||
open_buffdesc * | name | ||
) |
Get the next time range for the given time range.
[in] | client_handle | client handle from registration API |
[in] | prevName | previous time range name |
[out] | name | time range name |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | name | time range name |
[out] | val | entry count |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | name | time range name |
[in] | entry | time range entry |
[out] | val | periodic end date and time |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | name | time range name |
[in] | entry | time range entry |
[in] | val | periodic end date and time |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | name | time range name |
[in] | entry | time range entry |
[out] | val | periodic start date and time |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
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.
[in] | client_handle | client handle from registration API |
[in] | name | time range name |
[in] | val | periodic start date and time |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiTimeRangeStatusGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | name, | ||
OPEN_TIMERANGESTATUS_t * | val | ||
) |
Get the status for the given time range.
[in] | client_handle | client handle from registration API |
[in] | name | time range name |
[out] | val | status |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19