Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
openapi_userapp_config_db.h
Go to the documentation of this file.
1 
9 /**********************************************************************
10 *
11 * Copyright 2016-2018 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 ***********************************************************************
26 *
27 * @filename openapi_userapp_config_db.h
28 *
29 * @purpose UserAppConfigDb Configuration
30 *
31 * @component OPEN
32 *
33 * @create 25/09/2015
34 *
35 * @end
36 *
37 *********************************************************************/
38 #ifndef OPENAPI_USERAPP_CONFIG_DB_H_INCLUDED
39 #define OPENAPI_USERAPP_CONFIG_DB_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 /*****************************************************************/
66  open_buffdesc appDbName,
67  open_buffdesc keyName,
68  open_buffdesc keyData);
69 
70 /*****************************************************************/
96  open_buffdesc appDbName,
97  open_buffdesc keyName,
98  open_buffdesc *keyData);
99 
100 /*****************************************************************/
126  open_buffdesc appDbName,
127  open_buffdesc *keyName,
128  open_buffdesc *keyData);
129 
130 /*****************************************************************/
151  open_buffdesc appDbName,
152  open_buffdesc keyName);
153 
154 /*****************************************************************/
171  open_buffdesc appDbName);
172 
173 /*****************************************************************/
189  open_buffdesc appDbName);
190 #endif /* OPENAPI_USERAPP_CONFIG_DB_H_INCLUDED */
191 
open_error_t
OPEN uses these enumerators to indicate the error codes.
open_error_t openapiUserAppConfigDbGet(openapiClientHandle_t *client_handle, open_buffdesc appDbName, open_buffdesc keyName, open_buffdesc *keyData)
Get userAppConfigDb entry.
open_error_t openapiUserAppConfigDbCreateAppDb(openapiClientHandle_t *client_handle, open_buffdesc appDbName)
Create DB for specified application.
open_error_t openapiUserAppConfigDbRemoveItem(openapiClientHandle_t *client_handle, open_buffdesc appDbName, open_buffdesc keyName)
Remove userAppConfigDb entry.
open_error_t openapiUserAppConfigDbDeleteAppDb(openapiClientHandle_t *client_handle, open_buffdesc appDbName)
Delete DB for specified application.
open_error_t openapiUserAppConfigDbGetNext(openapiClientHandle_t *client_handle, open_buffdesc appDbName, open_buffdesc *keyName, open_buffdesc *keyData)
Get next userAppConfigDb entry.
open_error_t openapiUserAppConfigDbSet(openapiClientHandle_t *client_handle, open_buffdesc appDbName, open_buffdesc keyName, open_buffdesc keyData)
Add or update userAppConfigDb entry.