yumapro  23.10T-9
YumaPro SDK
Loading...
Searching...
No Matches
obj_errmsg.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2018 - 2021, YumaWorks, Inc., All Rights Reserved.
3 *
4 * Unless required by applicable law or agreed to in writing,
5 * software distributed under the License is distributed on an
6 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
7 * KIND, either express or implied. See the License for the
8 * specific language governing permissions and limitations
9 * under the License.
10 */
11#ifndef _H_obj_errmsg
12#define _H_obj_errmsg
13
14/* FILE: obj_errmsg.h
15*********************************************************************
16* *
17* P U R P O S E *
18* *
19*********************************************************************/
20
26/*********************************************************************
27* *
28* C H A N G E H I S T O R Y *
29* *
30*********************************************************************
31
32date init comment
33----------------------------------------------------------------------
3424-mar-18 abb Begun
35*/
36
37#include <xmlstring.h>
38
39#ifndef _H_obj
40#include "obj.h"
41#endif
42
43#ifndef _H_status_enum
44#include "status_enum.h"
45#endif
46
47#ifdef __cplusplus
48extern "C" {
49#endif
50
51/********************************************************************
52* *
53* F U N C T I O N S *
54* *
55*********************************************************************/
56
57
78extern void
80
81
91extern status_t
93 const xmlChar *basestr,
94 obj_errmsg_t **ret_errmsg);
95
96
104extern status_t
106 const xmlChar *parmstr);
107
116extern status_t
118 const xmlChar *parmstr,
119 boolean is_errortag);
120
121
129extern status_t
131 const xmlChar *langstr);
132
133
149extern status_t
150 obj_errmsg_check_val (const xmlChar *error_tag,
151 const xmlChar *error_app_tag,
152 const xmlChar *error_lang,
153 val_value_t *error_val,
154 xmlChar **retmsg);
155
156
170extern status_t
171 obj_errmsg_test_val (const xmlChar *error_tag,
172 const xmlChar *error_app_tag,
173 const xmlChar *error_lang,
174 val_value_t *error_val);
175
176
177
181#ifdef __cplusplus
182} /* end extern 'C' */
183#endif
184
185#endif /* _H_obj_errmsg */
status_t
global error return code
Definition: status_enum.h:210
void obj_errmsg_clean(obj_template_t *obj)
Clean the error messages within an object template.
Definition: obj_errmsg.c:429
status_t obj_errmsg_test_val(const xmlChar *error_tag, const xmlChar *error_app_tag, const xmlChar *error_lang, val_value_t *error_val)
Check if there needs to be a custom error msg.
Definition: obj_errmsg.c:703
status_t obj_errmsg_add(obj_template_t *obj, const xmlChar *basestr, obj_errmsg_t **ret_errmsg)
Create a new obj_errmsg struct for the object.
Definition: obj_errmsg.c:461
status_t obj_errmsg_set_lang(obj_errmsg_t *errmsg, const xmlChar *langstr)
Set the errmsg-lang for the errmsg.
Definition: obj_errmsg.c:569
status_t obj_errmsg_check_val(const xmlChar *error_tag, const xmlChar *error_app_tag, const xmlChar *error_lang, val_value_t *error_val, xmlChar **retmsg)
Get the custom error message if any configured for the eror_val.
Definition: obj_errmsg.c:616
status_t obj_errmsg_add_parm(obj_errmsg_t *errmsg, const xmlChar *parmstr)
Add an errmsg parameter for the object.
Definition: obj_errmsg.c:502
status_t obj_errmsg_add_filter(obj_errmsg_t *errmsg, const xmlChar *parmstr, boolean is_errortag)
Add an errmsg filter for the object.
Definition: obj_errmsg.c:535
Data Object Support.
global error status code enumerations
custom error message control block
Definition: obj.h:1188
One YANG data-def-stmt.
Definition: obj.h:1220
one value to match one type
Definition: val.h:912