Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
open_error_t openapiUserAppConfigDbCreateAppDb | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc | appDbName | ||
) |
Create DB for specified application.
[in] | client_handle | Client handle from registration API |
[in] | appDbName | Application DB name |
- | Minimum length 1 | |
- | Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE |
OPEN_E_NONE | Successful. |
OPEN_E_EXISTS | App. DB is already created. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_FAIL | Failed. |
OpEN API Version: 1.8
open_error_t openapiUserAppConfigDbDeleteAppDb | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc | appDbName | ||
) |
Delete DB for specified application.
[in] | appDbName | Application DB name |
- | Minimum length 1 | |
- | Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE |
OPEN_E_NONE | Successful. |
OPEN_E_NOT_FOUND | App. DB was not found. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_FAIL | Failed. |
OpEN API Version: 1.8
open_error_t openapiUserAppConfigDbGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc | appDbName, | ||
open_buffdesc | keyName, | ||
open_buffdesc * | keyData | ||
) |
Get userAppConfigDb entry.
[in] | client_handle | Client handle from registration API |
[in] | appDbName | Application DB name |
- | Minimum length 1 | |
- | Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE | |
[in] | keyName | Buffer descriptor key name |
- | Minimum length 1 | |
- | Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE | |
[in,out] | keyData | Pointer to key data. Memory must be allocated. If keyData->size is 0 or more than actual key data size then actual key data size will be returned. |
- | Minimum length 0 | |
- | Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE |
OPEN_E_NONE | Successful. |
OPEN_E_UNAVAIL | Key name was not found in app. DB. |
OPEN_E_NOT_FOUND | Input app. DB was not found. |
OPEN_E_PARAM | Error in parameter passed |
OPEN_E_FAIL | Failed. |
OpEN API Version: 1.6
open_error_t openapiUserAppConfigDbGetNext | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc | appDbName, | ||
open_buffdesc * | keyName, | ||
open_buffdesc * | keyData | ||
) |
Get next userAppConfigDb entry.
[in] | appDbName | application DB name |
[in] | keyName | pointer to next key name. Memory must be allocated. |
- | Minimum length 1 | |
- | Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE If (keyName->pstart[0] == L7_EOS) - first key will be returned. | |
[out] | keyData | pointer to next key data. Memory must be allocated. |
- | Minimum length 0 | |
- | Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE If L7_NULLPTR is specified then keySize will not be returned. If *keySize is 0 or more than actual key data size then actual key data size will be returned. |
OPEN_E_PARAM | in case of invalid input parameters |
OPEN_E_NONE | in case of successful operation |
OPEN_E_NOT_FOUND | if input application DB wasn't found |
OPEN_E_UNAVAIL | if item with specified keyName wasn't found |
OPEN_E_FAIL | if operation failed |
OpEN API Version: 1.11
open_error_t openapiUserAppConfigDbRemoveItem | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc | appDbName, | ||
open_buffdesc | keyName | ||
) |
Remove userAppConfigDb entry.
[in] | client_handle | Client handle from registration API |
[in] | appDbName | Application DB name |
- | Minimum length 1 | |
- | Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE | |
[in] | keyName | Buffer descriptor key name |
- | Minimum length 1 | |
- | Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE |
OPEN_E_NONE | successful. |
OPEN_E_FAIL | failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_UNAVAIL | Key name was not found in app. DB. |
OPEN_E_NOT_FOUND | Input app. DB was not found. |
OpEN API Version: 1.6
open_error_t openapiUserAppConfigDbSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc | appDbName, | ||
open_buffdesc | keyName, | ||
open_buffdesc | keyData | ||
) |
Add or update userAppConfigDb entry.
[in] | client_handle | Client handle from registration API |
[in] | appDbName | Application DB name |
- | Minimum length 1 | |
- | Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE | |
[in] | keyName | Buffer descriptor key name |
- | Minimum length 1 | |
- | Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE | |
[in] | keyData | pointer to buffer descriptor key data |
- | Minimum length 0 | |
- | Maximum length OPENAPI_USERAPP_DB_ENTRY_SIZE |
OPEN_E_NONE | Got successful. |
OPEN_E_FAIL | Got failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_NOT_FOUND | Input app. DB was not found. |
OpEN API Version: 1.6