![]() |
![]() |
![]() |
Libgnomedb Reference Manual | ![]() |
---|---|---|---|---|
GnomeDbXmlStorageGnomeDbXmlStorage — Interface which provides saving and loading using XML structures |
GnomeDbXmlStorage; GnomeDbXmlStorageIface; GType gnome_db_xml_storage_get_type (void); gchar* gnome_db_xml_storage_get_xml_id (GnomeDbXmlStorage *iface); xmlNodePtr gnome_db_xml_storage_save_to_xml (GnomeDbXmlStorage *iface, GError **error); gboolean gnome_db_xml_storage_load_from_xml (GnomeDbXmlStorage *iface, xmlNodePtr node, GError **error);
GnomeDbXmlStorage is implemented by GnomeDbTable, GnomeDbGraph, GnomeDbQfAll, GnomeDbQfValue, GnomeDbTarget, GnomeDbQuery, GnomeDbServer, GnomeDbDatabase, GnomeDbCondition, GnomeDbConstraint, GnomeDbQfFunc, GnomeDbServerDataType, GnomeDbServerFunction, GnomeDbGraphItem, GnomeDbGraphQuery, GnomeDbServerAggregate, GnomeDbQfAgg, GnomeDbTableField, GnomeDbJoin and GnomeDbQfField.
Any object which implements this interface can be streamed and restored to and from an XML file.
typedef struct { GTypeInterface g_iface; /* virtual table */ gchar *(* get_xml_id) (GnomeDbXmlStorage *iface); xmlNodePtr (* save_to_xml) (GnomeDbXmlStorage *iface, GError **error); gboolean (* load_from_xml) (GnomeDbXmlStorage *iface, xmlNodePtr node, GError **error); } GnomeDbXmlStorageIface;
gchar* gnome_db_xml_storage_get_xml_id (GnomeDbXmlStorage *iface);
Fetch the xml id string of the object, it's up to the caller to free the string.
iface : |
an object which implements the GnomeDbXmlStorage interface |
Returns : | the xml id. |
xmlNodePtr gnome_db_xml_storage_save_to_xml (GnomeDbXmlStorage *iface, GError **error);
Creates a new xmlNodePtr structure and fills it with data representing the object given as argument.
iface : |
an object which implements the GnomeDbXmlStorage interface |
error : |
location to store error, or NULL
|
Returns : | the new XML node, or NULL if an error occurred. |
gboolean gnome_db_xml_storage_load_from_xml (GnomeDbXmlStorage *iface, xmlNodePtr node, GError **error);
Updates the object with data stored in the XML node. The object MUST already exist and be of the correct type before calling this function. This is a virtual function.
iface : |
an object which implements the GnomeDbXmlStorage interface |
node : |
an XML node from an XML structure |
error : |
location to store error, or NULL
|
Returns : | TRUE if no error occurred. |