Logging functionality: gexiv2 Reference Manual

## Logging functionality Logging functionality — Utility functions related to GExiv2's and Exiv2's logging. |

## Functions

void | (*GExiv2LogHandler) ()
GExiv2LogLevel | gexiv2_log_get_level ()
void | gexiv2_log_set_level ()
GExiv2LogHandler | gexiv2_log_get_handler ()
GExiv2LogHandler | gexiv2_log_get_default_handler ()
void | gexiv2_log_set_handler ()
void | gexiv2_log_use_glib_logging ()

## Types and Values

enum | GExiv2LogLevel

## Description

The functions in this modules can be used do configure the log level of GExiv2 and Exiv2 in terms of what to log (see `gexiv2_log_set_level()`) and how. Either a custom log handler can be used or GLib's logging mechanisms.

## Functions

### GExiv2LogHandler ()

    void
    (*GExiv2LogHandler) (GExiv2LogLevel level,
                         const gchar *msg);

The log handler can be set by `gexiv2_log_set_handler()`. When set, the log handler will receive all log messages emitted by Exiv2 and gexiv2. It's up to the handler to decide where (and if) the images are displayed or stored.

#### Parameters

level | The GExiv2LogLevel for the particular message |
msg | The log message. | [in]

### gexiv2_log_get_level ()

    GExiv2LogLevel
    gexiv2_log_get_level (void);

#### Returns

The current GExiv2LogLevel. Messages below this level will not be logged.

### gexiv2_log_set_level ()

    void
    gexiv2_log_set_level (GExiv2LogLevel level);

Log messages below this level will not be logged.

#### Parameters

level | The GExiv2LogLevel gexiv2 should respect. |

### gexiv2_log_get_handler ()

    GExiv2LogHandler
    gexiv2_log_get_handler (void);

[skip]

#### Returns

The current GExiv2LogHandler, or the default if none set. See gexiv2_log_get_default_handler.

### gexiv2_log_get_default_handler ()

    GExiv2LogHandler
    gexiv2_log_get_default_handler (void);

[skip]

#### Returns

The default GExiv2LogHandler, which uses Exiv2's built-in handler. Exiv2 will send the message to stderr.

### gexiv2_log_set_handler ()

    void
    gexiv2_log_set_handler (GExiv2LogHandler handler);

This method is not thread-safe. It's best to set this before beginning to use gexiv2.

[skip]

#### Parameters

handler | A GExiv2LogHandler callback to begin receiving log messages from Exiv2 and gexiv2 |

### gexiv2_log_use_glib_logging ()

    void
    gexiv2_log_use_glib_logging (void);

When called, gexiv2 will install it's own GExiv2LogHandler which redirects all Exiv2 and gexiv2 log messages to GLib's logging calls (`g_debug()`, `g_message()`, `g_warning()`, and `g_critical()` for the respective GExiv2LogLevel value). GEXIV2_LOG_LEVEL_MUTE logs are dropped.

One advantage to using this is that GLib's logging control and handlers can be used rather than GExiv2's ad hoc scheme. It also means an application can use GLib logging and have all its messages routed through the same calls.

## Types and Values

### enum GExiv2LogLevel

GExiv2 log levels

#### Members

GEXIV2_LOG_LEVEL_DEBUG | Log level for debugging |
GEXIV2_LOG_LEVEL_INFO | Log level for informational messages |
GEXIV2_LOG_LEVEL_WARN | Log level for warning messages |
GEXIV2_LOG_LEVEL_ERROR | Log level for error messages |
GEXIV2_LOG_LEVEL_MUTE | Suppress all log messages |