Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Functions
To Access System Registry Parameters [OPENAPI_REGISTRY]

Macros

#define OPEN_REGISTRY_PARAM_SIZE   256
 

Functions

open_error_t openapiSystemRegCodeVersionGet (openapiClientHandle_t *client_handle, open_buffdesc *code_version)
 Get the software version information. More...
 
open_error_t openapiSystemRegMachineModelGet (openapiClientHandle_t *client_handle, open_buffdesc *machine_model)
 Get the Machine Model number. More...
 
open_error_t openapiSystemRegMachineTypeGet (openapiClientHandle_t *client_handle, open_buffdesc *machine_model)
 Get the Machine Type Information. More...
 
open_error_t openapiSystemRegSerialNumGet (openapiClientHandle_t *client_handle, open_buffdesc *serial_number)
 Get the serial number. More...
 

Detailed Description

Function Documentation

open_error_t openapiSystemRegCodeVersionGet ( openapiClientHandle_t client_handle,
open_buffdesc code_version 
)

Get the software version information.

Parameters
[in]client_handleClient handle from registration API
[out]code_versionSoftware version
Return values
OPEN_E_NONEGet successful.
OPEN_E_FAILGet failed.
OPEN_E_PARAMError in parameter passed.
Note
Minimum size of code_version should be OPEN_REGISTRY_PARAM_SIZE.

OpEN API Version: 1.19

Examples:
registry_example.c.
open_error_t openapiSystemRegMachineModelGet ( openapiClientHandle_t client_handle,
open_buffdesc machine_model 
)

Get the Machine Model number.

Parameters
[in]client_handleClient handle from registration API
[out]machine_modelMachine Model Number
Return values
OPEN_E_NONEif model number get successful.
OPEN_E_FAILif model number get failed.
OPEN_E_PARAMif machine_model->size supplied is not enough.
Note
Minimum size of machine_model should be OPEN_REGISTRY_PARAM_SIZE.

OpEN API Version: 1.3

Examples:
registry_example.c.
open_error_t openapiSystemRegMachineTypeGet ( openapiClientHandle_t client_handle,
open_buffdesc machine_model 
)

Get the Machine Type Information.

Parameters
[in]client_handleClient handle from registration API
[out]machine_typeMachine type
Return values
OPEN_E_NONEif model type get successful.
OPEN_E_FAILif model type get failed.
OPEN_E_PARAMif machine_type->size supplied is not enough.
Note
Minimum size of machine_type should be OPEN_REGISTRY_PARAM_SIZE.

OpEN API Version: 1.3

Examples:
registry_example.c.
open_error_t openapiSystemRegSerialNumGet ( openapiClientHandle_t client_handle,
open_buffdesc serial_number 
)

Get the serial number.

Parameters
[in]client_handleClient handle from registration API
[out]serial_numberSerial Number
Return values
OPEN_E_NONEif serial number get successful.
OPEN_E_FAILif serial number get failed.
OPEN_E_PARAMif serial_number->size supplied is not enough.
Note
Minimum size of serial_number should be OPEN_REGISTRY_PARAM_SIZE.

OpEN API Version: 1.3

Examples:
registry_example.c.