Top | ![]() |
![]() |
![]() |
![]() |
The functions in this section allow applications an easy access to the libgda configuration, thus making them able to access the list of data sources configured in the system, for instance.
gchar *
gda_config_get_string (const gchar *path
);
Gets the value of the specified configuration entry as a string. You are then responsible to free the returned string.
gint
gda_config_get_int (const gchar *path
);
Gets the value of the specified configuration entry as an integer.
gdouble
gda_config_get_float (const gchar *path
);
Gets the value of the specified configuration entry as a float.
gboolean
gda_config_get_boolean (const gchar *path
);
Gets the value of the specified configuration entry as a boolean.
gboolean gda_config_set_string (const gchar *path
,const gchar *new_value
);
Sets the given configuration entry to contain a string.
gboolean gda_config_set_int (const gchar *path
,gint new_value
);
Sets the given configuration entry to contain an integer.
gboolean gda_config_set_float (const gchar *path
,gdouble new_value
);
Sets the given configuration entry to contain a float.
gboolean gda_config_set_boolean (const gchar *path
,gboolean new_value
);
Sets the given configuration entry to contain a boolean.
void
gda_config_remove_section (const gchar *path
);
Removes the given section from the configuration database.
void
gda_config_remove_key (const gchar *path
);
Removes the given entry from the configuration database. If the section is empty, also remove the section.
gboolean
gda_config_has_section (const gchar *path
);
Checks whether the given section exists in the configuration system.
gboolean
gda_config_has_key (const gchar *path
);
Checks whether the given key exists in the configuration system.
GList *
gda_config_list_sections (const gchar *path
);
Returns a GList containing the names of all the sections available under the given root directory.
To free the returned value, you can use gda_config_free_list.
GList *
gda_config_list_keys (const gchar *path
);
Returns a list of all keys that exist under the given path.
To free the returned value, you can use gda_config_free_list.
void
gda_config_free_list (GList *list
);
Frees all memory used by the given GList, which must be the return value from either gda_config_list_sections and gda_config_list_keys.
GList *
gda_config_get_provider_list (void
);
Returns a list of all providers currently installed in the system. Each of the nodes in the returned GList is a GdaProviderInfo.
void
gda_config_free_provider_list (GList *list
);
Frees a list of GdaProviderInfo structures.
GdaProviderInfo *
gda_config_get_provider_by_name (const gchar *name
);
Gets a GdaProviderInfo structure from the provider list given its name, don't modify or free it.
GdaDataModel *
gda_config_get_provider_model (void
);
Fills and returns a new GdaDataModel object using information from all providers which are currently installed in the system.
Rows are separated in 3 columns: 'Id', 'Location' and 'Description'.
GdaProviderInfo *
gda_provider_info_copy (GdaProviderInfo *src
);
Creates a new GdaProviderInfo structure from an existing one.
void
gda_provider_info_free (GdaProviderInfo *provider_info
);
Deallocates all memory associated to the given GdaProviderInfo.
GList *
gda_config_get_data_source_list (void
);
Returns a list of all data sources currently configured in the system. Each of the nodes in the returned GList is a GdaDataSourceInfo. To free the returned list, call the gda_config_free_data_source_list function.
GdaDataSourceInfo *
gda_config_find_data_source (const gchar *name
);
Gets a GdaDataSourceInfo structure from the data source list given its
name. After usage, the returned structure's memory must be freed using
gda_data_source_info_free()
.
GdaDataSourceInfo *
gda_data_source_info_copy (GdaDataSourceInfo *src
);
Creates a new GdaDataSourceInfo structure from an existing one.
gboolean gda_data_source_info_equal (GdaDataSourceInfo *info1
,GdaDataSourceInfo *info2
);
Tells if info1
and info2
are equal
void
gda_data_source_info_free (GdaDataSourceInfo *info
);
Deallocates all memory associated to the given GdaDataSourceInfo.
void
gda_config_free_data_source_list (GList *list
);
Frees a list of GdaDataSourceInfo structures.
GdaDataModel *
gda_config_get_data_source_model (void
);
Fills and returns a new GdaDataModel object using information from all data sources which are currently configured in the system.
Rows are separated in 6 columns: 'Name', 'Provider', 'Connection string', 'Description', 'Username' and 'Global'.
gboolean
gda_config_can_modify_global_config (void
);
Tells if the calling program can modify the global configured data sources.
gboolean gda_config_save_data_source (const gchar *name
,const gchar *provider
,const gchar *cnc_string
,const gchar *description
,const gchar *username
,const gchar *password
,gboolean is_global
);
Adds a new data source (or update an existing one) to the GDA configuration, based on the parameters given.
name |
name for the data source to be saved. |
|
provider |
provider ID for the new data source. |
|
cnc_string |
connection string for the new data source. |
|
description |
description for the new data source. |
|
username |
user name for the new data source. |
|
password |
password to use when authenticating |
|
is_global |
TRUE if the data source is system-wide |
gboolean
gda_config_save_data_source_info (GdaDataSourceInfo *dsn_info
);
Saves a data source in the libgda configuration given a GdaDataSourceInfo structure containing all the information about the data source.
void
gda_config_remove_data_source (const gchar *name
);
Removes the given data source from the GDA configuration.
guint gda_config_add_listener (const gchar *path
,GdaConfigListenerFunc func
,gpointer user_data
);
Installs a configuration listener, which is a callback function which will be called every time a change occurs on a given configuration entry.
path |
configuration path to listen to. |
|
func |
callback function. |
|
user_data |
data to be passed to the callback function. |
the ID of the listener, which you will need for calling gda_config_remove_listener. If an error occurs, 0 is returned.
void
gda_config_remove_listener (guint id
);
Removes a configuration listener previously installed with gda_config_add_listener, given its ID.