obj_errmsg.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 - 2021, YumaWorks, Inc., All Rights Reserved.
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
#ifndef _H_obj_errmsg
#define _H_obj_errmsg
 
/*  FILE: obj_errmsg.h
*********************************************************************
*                                   *
*            P U R P O S E                  *
*                                   *
*********************************************************************/
 
/*********************************************************************
*                                   *
*          C H A N G E   H I S T O R Y              *
*                                   *
*********************************************************************
 
date         init     comment
----------------------------------------------------------------------
24-mar-18    abb      Begun
*/
 
#include <xmlstring.h>
 
#ifndef _H_obj
#include "obj.h"
#endif
 
#ifndef _H_status_enum
#include "status_enum.h"
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/********************************************************************
*                                   *
*           F U N C T I O N S               *
*                                   *
*********************************************************************/
 
 
extern void
    obj_errmsg_clean (obj_template_t *obj);
 
 
extern status_t
    obj_errmsg_add (obj_template_t *obj,
                    const xmlChar *basestr,
                    obj_errmsg_t **ret_errmsg);
 
 
extern status_t
    obj_errmsg_add_parm (obj_errmsg_t *errmsg,
                         const xmlChar *parmstr);
 
extern status_t
    obj_errmsg_add_filter (obj_errmsg_t *errmsg,
                           const xmlChar *parmstr,
                           boolean is_errortag);
 
 
extern status_t
    obj_errmsg_set_lang (obj_errmsg_t *errmsg,
                         const xmlChar *langstr);
 
 
extern 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);
 
 
extern status_t
    obj_errmsg_test_val (const xmlChar *error_tag,
                         const xmlChar *error_app_tag,
                         const xmlChar *error_lang,
                         val_value_t *error_val);
 
 
 
#ifdef __cplusplus
}  /* end extern 'C' */
#endif
 
#endif      /* _H_obj_errmsg */