TeplMetadata: libgedit-tepl 6 Reference Manual

TeplMetadata

TeplMetadata — File metadata

struct

    GObject
    ╰── TeplMetadata

#include <tepl/tepl.h>

A TeplMetadata object contains a set of file metadata as key/value pairs.

The tepl_metadata_get() and tepl_metadata_set() functions don't load or save the metadata on disk, they only access the metadata stored in the TeplMetadata object memory.

TeplMetadata is intended to be used alongside TeplMetadataManager to load and store the metadata on disk.

Values must be nul-terminated UTF-8 strings.

Keys must be non-empty strings containing only:

Additionally, it's preferable that keys start with a namespace, to not get metadata conflicts between the application and libraries.

Examples of valid metadata keys:

TeplMetadata *
tepl_metadata_new (void);

a new, empty TeplMetadata object.

Since: 5.0

gchar *
tepl_metadata_get (TeplMetadata *metadata,
                   const gchar *key);

Gets the value of a metadata stored in the metadata object memory.

metadata	a TeplMetadata.
key	a key.

the associated value (a UTF-8 string), or NULL. Free with g_free() when no longer needed.

[transfer full][nullable]

Since: 5.0

void
tepl_metadata_set (TeplMetadata *metadata,
                   const gchar *key,
                   const gchar *value);

Sets or unsets key . This function just stores the new metadata value in the metadata object memory.

metadata	a TeplMetadata.
key	a key.
value	a nul-terminated UTF-8 string, or `NULL` to unset the key.	[nullable]

Since: 5.0

struct TeplMetadata;