Man page - log4c_layout_get_name(3)
Packages contains this manual
- log4c_logging_event.h(3)
- log4c_rollingpolicy_init(3)
- log4c_appender_delete(3)
- log4c_category_print(3)
- log4c_appender_type_rollingfile.h(3)
- log4c_category_delete(3)
- log4c_category_get(3)
- log4c_category_is_debug_enabled(3)
- log4c_rollingpolicy_type_set(3)
- log4c_appender_type_set(3)
- log4c_layout_type_basic_r.h(3)
- log4c_rollingpolicy_is_triggering_event(3)
- log4c_layout_type_define(3)
- log4c_load(3)
- log4c_appender_type_rollingfile(3)
- log4c_category_notice(3)
- log4c_rc(3)
- log4c_init.h(3)
- log4c_appender_type_mmap(3)
- log4c_layout.h(3)
- log4c_layout_get_type(3)
- log4c_appender_get_layout(3)
- log4c_category_is_alert_enabled(3)
- log4c_priority_to_int(3)
- log4c_priority.h(3)
- log4c_rollingpolicy_sizewin_udata_t(3)
- log4c_priority_to_string(3)
- log4c_rollingpolicy_set_udata(3)
- log4c_stream2_set_flags(3)
- log4c_buffer_t(3)
- log4c_appender_types_print(3)
- log4c_rollingpolicy_get(3)
- log4c_layout_t(3)
- log4c_appender_types_free(3)
- log4c_rollingpolicy_fini(3)
- log4c_appender_type_stream2(3)
- log4c_rollingfile_udata_set_logdir(3)
- log4c_rollingfile_udata_get_logdir(3)
- log4c_layout_type_dated_local_r.h(3)
- log4c_category_set_appender(3)
- log4c_stream2_get_fp(3)
- log4c_category_is_notice_enabled(3)
- log4c_rollingpolicy_set_type(3)
- log4c_rollingpolicy_get_udata(3)
- log4c_appender_get_name(3)
- log4c_appender_print(3)
- log4c_layout_types_free(3)
- log4c_layout_type_set(3)
- log4c_appender_type_t(3)
- log4c_category_crit(3)
- log4c_appender_type_stream2.h(3)
- log4c_location(3)
- log4c_layout_get(3)
- log4c_appender_new(3)
- log4c_logging_event_delete(3)
- log4c_appender_t(3)
- log4c_appender_set_udata(3)
- log4c_stream2_set_fp(3)
- log4c_category_alert(3)
- log4c_appender_type_stream(3)
- log4c_appender_get(3)
- log4c_fini(3)
- log4c_buffer.h(3)
- log4c_category_get_priority(3)
- log4c_layout_type_dated_r.h(3)
- log4c_category_get_name(3)
- log4c_appender_get_type(3)
- log4c_category_define(3)
- log4c_category_log_locinfo(3)
- log4c_micro_version(3)
- log4c_category_log(3)
- log4c_category_get_appender(3)
- log4c_category_is_fatal_enabled(3)
- log4c_sizewin_udata_set_appender(3)
- log4c_category_debug(3)
- log4c_layout_delete(3)
- log4c_appender_set_type(3)
- log4c_logging_event_new(3)
- log4c_location_info_t(3)
- log4c_category_is_warn_enabled(3)
- log4c_appender_get_udata(3)
- log4c_category_list(3)
- log4c_logging_event_t(3)
- log4c_rollingfile_udata_set_policy(3)
- log4c_deprecated(3)
- log4c_sizewin_udata_set_max_num_files(3)
- log4c_category_is_info_enabled(3)
- log4c_rc.h(3)
- log4c_category_t(3)
- log4c_category_error(3)
- log4c_category_is_priority_enabled(3)
- log4c_rollingfile_udata_get_files_prefix(3)
- log4c_layout_print(3)
- log4c_rollingpolicy_get_rfudata(3)
- log4c___log4c_category_trace(3)
- log4c_category_fatal(3)
- log4c_layout_new(3)
- log4c_location_info.h(3)
- log4c_category_is_crit_enabled(3)
- log4c_layout_type_t(3)
- log4c_layout_type(3)
- log4c_layout_types_print(3)
- log4c_rollingpolicy.h(3)
- log4c_appender_close(3)
- log4c_layout_get_name(3)
- log4c_appender_type_get(3)
- log4c_init(3)
- log4c_rollingpolicy_type_t(3)
- log4c_appender.h(3)
- log4c_layout_format(3)
- log4c_category_get_chainedpriority(3)
- log4c_appender_type_syslog(3)
- log4c_category_set_additivity(3)
- log4c_category.h(3)
- log4c_category_is_trace_enabled(3)
- log4c_appender_open(3)
- log4c_rollingpolicy_type_get(3)
- log4c_bug(3)
- log4c_minor_version(3)
- log4c_version.h(3)
- log4c_appender_type_mmap.h(3)
- log4c_layout_get_udata(3)
- log4c_sizewin_make_udata(3)
- log4c_appender_type_stream.h(3)
- log4c_category_warn(3)
- log4c_category_new(3)
- log4c_layout_type_dated.h(3)
- log4c_layout_set_udata(3)
- log4c_appender_type(3)
- log4c_appender_append(3)
- log4c_layout_set_type(3)
- log4c_stream2_get_flags(3)
- log4c_rollingpolicy_type(3)
- log4c_rollingpolicy_t(3)
- log4c_category_is_error_enabled(3)
- log4c_rollingfile_get_current_file_size(3)
- log4c_appender_set_layout(3)
- log4c_major_version(3)
- log4c_layout_type_get(3)
- log4c_layout_type_dated_local.h(3)
- log4c_appender_type_syslog.h(3)
- log4c_category_info(3)
- log4c_rollingpolicy_type_sizewin.h(3)
- log4c_version(3)
- log4c_todo(3)
- log4c_category_get_additivity(3)
- log4c_priority_level_t(3)
- log4c_sizewin_udata_set_file_maxsize(3)
- log4c_rollingfile_udata_set_files_prefix(3)
- log4c_layout_type_basic.h(3)
- log4c_rollingfile_make_udata(3)
- log4c_rc_t(3)
- log4c_category_set_priority(3)
- log4c_appender_type_define(3)
apt-get install liblog4c-doc
Manual
layout.h
NAMESYNOPSIS
Data Structures
Macros
Typedefs
Functions
Detailed Description
Macro Definition Documentation
#define log4c_layout_type_define(a_type)
Typedef Documentation
typedef struct __log4c_layout log4c_layout_t
typedef struct log4c_layout_type log4c_layout_type_t
Function Documentation
void log4c_layout_delete (log4c_layout_t * a_layout)
const char * log4c_layout_format (const log4c_layout_t * a_layout, constlog4c_logging_event_t * a_event)
log4c_layout_t * log4c_layout_get (const char * a_name)
const char * log4c_layout_get_name (const log4c_layout_t * a_layout)
const log4c_layout_type_t * log4c_layout_get_type (const log4c_layout_t *a_layout)
void * log4c_layout_get_udata (const log4c_layout_t * a_layout)
log4c_layout_t * log4c_layout_new (const char * a_name)
void log4c_layout_print (const log4c_layout_t * a_layout, FILE * a_stream)
const log4c_layout_type_t * log4c_layout_set_type (log4c_layout_t *a_layout, const log4c_layout_type_t * a_type)
void * log4c_layout_set_udata (log4c_layout_t * a_layout, void * a_udata)
const log4c_layout_type_t * log4c_layout_type_get (const char * a_name)
const log4c_layout_type_t * log4c_layout_type_set (constlog4c_layout_type_t * a_type)
void log4c_layout_types_free (void)
void log4c_layout_types_print (FILE * fp)
Author
NAME
layout.h - Interface for user specific layout format of log4c_logging_event events.
SYNOPSIS
#include
<log4c/defs.h>
#include <log4c/logging_event.h>
#include <stdio.h>
Data Structures
struct
log4c_layout_type
log4c layout type class
Macros
#define log4c_layout_type_define (a_type)
Typedefs
typedef struct
__log4c_layout
log4c_layout_t
typedef struct
log4c_layout_type log4c_layout_type_t
log4c layout type class
Functions
const
log4c_layout_type_t
*
log4c_layout_type_get
(const char *a_name)
const
log4c_layout_type_t
*
log4c_layout_type_set
(const
log4c_layout_type_t
*a_type)
log4c_layout_t
*
log4c_layout_get
(const char
*a_name)
log4c_layout_t
*
log4c_layout_new
(const char
*a_name)
void
log4c_layout_delete
(
log4c_layout_t
*a_layout)
const char *
log4c_layout_get_name
(const
log4c_layout_t
*a_layout)
const
log4c_layout_type_t
*
log4c_layout_get_type
(const
log4c_layout_t
*a_layout)
const
log4c_layout_type_t
*
log4c_layout_set_type
(
log4c_layout_t
*a_layout, const
log4c_layout_type_t
*a_type)
void *
log4c_layout_get_udata
(const
log4c_layout_t
*a_layout)
void *
log4c_layout_set_udata
(
log4c_layout_t
*a_layout, void *a_udata)
const char *
log4c_layout_format
(const
log4c_layout_t
*a_layout, const
log4c_logging_event_t
*a_event)
void
log4c_layout_print
(const
log4c_layout_t
*a_layout, FILE *a_stream)
void
log4c_layout_types_free
(void)
void
log4c_layout_types_print
(FILE *fp)
Detailed Description
Interface for user specific layout format of log4c_logging_event events.
Todo
the layout interface needs a better configuration system depending on the layout type. The udata field is a just a trick.
Todo
a pattern layout would be welcomed !!
Macro Definition Documentation
#define log4c_layout_type_define(a_type)
Helper macro to define static layout types.
Parameters
a_type the log4c_layout_type_t object to define
Warning
needs GCC support: otherwise this macro does nothing
Deprecated
This macro, and the static initialialization of layouts in general, is deprecated. Use rather the log4c_layout_type_set() function to initialize your appenders before calling log4c_init()
Typedef Documentation
typedef struct __log4c_layout log4c_layout_t
log4c layout class
typedef struct log4c_layout_type log4c_layout_type_t
log4c layout
type class Attributes description:
•
name layout type name
•
format
Function Documentation
void log4c_layout_delete (log4c_layout_t * a_layout)
Destructor for layout.
const char * log4c_layout_format (const log4c_layout_t * a_layout, constlog4c_logging_event_t * a_event)
format a log4c_logging_event
events to a string.
Parameters
a_layout
the
log4c_layout_t object
a_event
a logging_event_t object
Returns
an appendable string.
log4c_layout_t * log4c_layout_get (const char * a_name)
Get a pointer to an existing
layout.
Parameters
a_name the name of the layout to return.
Returns
a pointer to an existing layout, or NULL if no layout with the specfied name exists.
const char * log4c_layout_get_name (const log4c_layout_t * a_layout)
Parameters
a_layout the log4c_layout_t object
Returns
the layout name
const log4c_layout_type_t * log4c_layout_get_type (const log4c_layout_t *a_layout)
Parameters
a_layout the log4c_layout_t object
Returns
a log4c_layout_type_t object
void * log4c_layout_get_udata (const log4c_layout_t * a_layout)
Parameters
a_layout the log4c_layout_t object
Returns
the layout user data
log4c_layout_t * log4c_layout_new (const char * a_name)
Constructor for layout.
void log4c_layout_print (const log4c_layout_t * a_layout, FILE * a_stream)
prints the layout on a stream
Parameters
a_layout
the
log4c_layout_t object
a_stream
the stream
const log4c_layout_type_t * log4c_layout_set_type (log4c_layout_t *a_layout, const log4c_layout_type_t * a_type)
sets the layout type
Parameters
a_layout
the
log4c_layout_t object
a_type
the new layout type
Returns
the previous layout type
void * log4c_layout_set_udata (log4c_layout_t * a_layout, void * a_udata)
sets the layout user data
Parameters
a_layout
the
log4c_layout_t object
a_udata
the new layout user data
Returns
the previous layout user data
const log4c_layout_type_t * log4c_layout_type_get (const char * a_name)
Get a pointer to an existing
layout type.
Parameters
a_name the name of the layout type to return.
Returns
a pointer to an existing layout type, or NULL if no layout type with the specified name exists.
const log4c_layout_type_t * log4c_layout_type_set (constlog4c_layout_type_t * a_type)
Use this function to register a
layout type with log4c. Once this is done you may refer to
this type by name both programatically and in the log4c
configuration file.
Parameters
a_type a pointer to the new layout type to set.
Returns
a pointer to the previous layout type of same name.
Example code fragment:
const log4c_layout_type_t log4c_layout_type_xml = {
"s13_xml",
xml_format,
};
log4c_layout_type_set(&log4c_layout_type_xml);
void log4c_layout_types_free (void)
free all layout types
void log4c_layout_types_print (FILE * fp)
prints all the current
registered layout types on a stream
Parameters
fp the stream
Author
Generated automatically by Doxygen for log4c from the source code.