Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Macros | |
#define | OPEN_RFC1213_PARAM_SIZE 256 |
open_error_t openapi1213SystemSysContactGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | sys_contact | ||
) |
Get the system contact information.
[in] | client_handle | Client handle from registration API |
[out] | sys_contact | System contact |
minimum | buffer size OPEN_RFC1213_PARAM_SIZE |
OPEN_E_NONE | if system contact get is successful. |
OPEN_E_FAIL | if system contact get has failed. |
OPEN_E_PARAM | invalid sys_contact parameter |
OpEN API Version: 1.7
open_error_t openapi1213SystemSysContactSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | sys_contact | ||
) |
Set the system contact information.
[in] | client_handle | Client handle from registration API |
[in] | sys_contact | System contact |
maximum | buffer size OPEN_RFC1213_PARAM_SIZE - 1 |
OPEN_E_NONE | if system contact set is successful. |
OPEN_E_FAIL | if system contact set has failed. |
OPEN_E_PARAM | invalid sys_contact parameter |
OpEN API Version: 1.7
open_error_t openapi1213SystemSysDescrGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | sys_descr | ||
) |
Get the system description.
[in] | client_handle | Client handle from registration API |
[out] | sys_descr | System description |
minimum | buffer size OPEN_RFC1213_PARAM_SIZE |
OPEN_E_NONE | if system description get is successful. |
OPEN_E_FAIL | if system description get failed. |
OPEN_E_PARAM | invalid sys_descr parameter |
OpEN API Version: 1.7
open_error_t openapi1213SystemSysLocationGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | sys_location | ||
) |
Get the system location.
[in] | client_handle | Client handle from registration API |
[out] | sys_location | System location |
minimum | buffer size OPEN_RFC1213_PARAM_SIZE |
OPEN_E_NONE | if system location get is successful. |
OPEN_E_FAIL | if system location get has failed. |
OPEN_E_PARAM | invalid sys_location parameter |
OpEN API Version: 1.7
open_error_t openapi1213SystemSysLocationSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | sys_location | ||
) |
Set the system location.
[in] | client_handle | Client handle from registration API |
[in] | sys_location | System location |
maximum | buffer size OPEN_RFC1213_PARAM_SIZE - 1 |
OPEN_E_NONE | if system location set is successful. |
OPEN_E_FAIL | if system location set has failed. |
OPEN_E_PARAM | invalid sys_location parameter |
OpEN API Version: 1.7
open_error_t openapi1213SystemSysNameGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | sys_name | ||
) |
Get the system name.
[in] | client_handle | Client handle from registration API |
[out] | sys_name | System name |
minimum | buffer size OPEN_RFC1213_PARAM_SIZE |
OPEN_E_NONE | if system name get is successful. |
OPEN_E_FAIL | if system name get has failed. |
OPEN_E_PARAM | invalid sys_name parameter |
OpEN API Version: 1.7
open_error_t openapi1213SystemSysNameSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | sys_name | ||
) |
Set the system name.
[in] | client_handle | Client handle from registration API |
[in] | sys_name | System name |
maximum | buffer size OPEN_RFC1213_PARAM_SIZE - 1 |
OPEN_E_NONE | if system name set is successful. |
OPEN_E_FAIL | if system name set has failed. |
OPEN_E_PARAM | invalid system name parameter |
OpEN API Version: 1.7