Parameter API

Functions

gchar * gfal2_get_opt_string (gfal2_context_t handle, const gchar *group_name, const gchar *key, GError **error)
 get a string parameter in the current GFAL 2.0 configuration see gfal2.d configuration files or gfal 2.0 documentation to know group/key/values
gint gfal2_set_opt_string (gfal2_context_t handle, const gchar *group_name, const gchar *key, gchar *value, GError **error)
 set a string parameter in the current GFAL 2.0 configuration see gfal2.d configuration files or gfal 2.0 documentation to know group/key/values
gint gfal2_get_opt_integer (gfal2_context_t handle, const gchar *group_name, const gchar *key, GError **error)
 get an integer parameter in the current GFAL 2.0 configuration see gfal2.d configuration files or gfal 2.0 documentation to know group/key/values
gint gfal2_get_opt_integer_with_default (gfal2_context_t context, const gchar *group_name, const gchar *key, gint default_value)
 similar to gfal2_get_opt_integer but return a default value if an error occures
gint gfal2_set_opt_integer (gfal2_context_t handle, const gchar *group_name, const gchar *key, gint value, GError **error)
 set an integer parameter in the current GFAL 2.0 configuration see gfal2.d configuration files or gfal 2.0 documentation to know group/key/values
gint gfal2_set_opt_boolean (gfal2_context_t handle, const gchar *group_name, const gchar *key, gboolean value, GError **error)
 set a boolean parameter in the current GFAL 2.0 configuration see gfal2.d configuration files or gfal 2.0 documentation to know group/key/values
gboolean gfal2_get_opt_boolean (gfal2_context_t handle, const gchar *group_name, const gchar *key, GError **error)
 get a boolean parameter in the current GFAL 2.0 configuration see gfal2.d configuration files or gfal 2.0 documentation to know group/key/values
gboolean gfal2_get_opt_boolean_with_default (gfal2_context_t handle, const gchar *group_name, const gchar *key, gboolean default_value)
 similar to gfal2_get_opt_boolean but return a default value if an error occures
gint gfal2_set_opt_string_list (gfal_handle handle, const gchar *group_name, const gchar *key, const gchar *const list[], gsize length, GError **error)
 set a list of string parameter in the current GFAL 2.0 configuration see gfal2.d configuration files or gfal 2.0 documentation to know group/key/values
gchar ** gfal2_get_opt_string_list (gfal_handle handle, const gchar *group_name, const gchar *key, gsize *length, GError **error)
 get a list of string parameter in the current GFAL 2.0 configuration see gfal2.d configuration files or gfal 2.0 documentation to know group/key/values
gchar ** gfal2_get_opt_string_list_with_default (gfal_handle handle, const gchar *group_name, const gchar *key, gsize *length, char **default_value)

Detailed Description

Allows to overwrite or/and define any parameter of gfal 2.0. A complete list of parameter is accessible in the gfal 2.0 configuration files directory ( by default : /etc/gfal2.d/ )

Example ( enable IPv6 support for the gridFTP plugin ) : gfal2_set_opt_boolean("GRIDFTP PLUGIN", "IPV6", true, NULL);


Function Documentation

gboolean gfal2_get_opt_boolean ( gfal2_context_t  handle,
const gchar *  group_name,
const gchar *  key,
GError **  error 
)

get a boolean parameter in the current GFAL 2.0 configuration see gfal2.d configuration files or gfal 2.0 documentation to know group/key/values

Parameters:
handle : context of gfal 2.0
group_name : group name of the parameter
key : key of the parameter
error : GError error report system
Returns:
parameter value
gboolean gfal2_get_opt_boolean_with_default ( gfal2_context_t  handle,
const gchar *  group_name,
const gchar *  key,
gboolean  default_value 
)

similar to gfal2_get_opt_boolean but return a default value if an error occures

Parameters:
handle : context of gfal 2.0
group_name : group name of the parameter
key : key of the parameter
bool : default value returned if not present
Returns:
parameter value
gint gfal2_get_opt_integer ( gfal2_context_t  handle,
const gchar *  group_name,
const gchar *  key,
GError **  error 
)

get an integer parameter in the current GFAL 2.0 configuration see gfal2.d configuration files or gfal 2.0 documentation to know group/key/values

Parameters:
handle : context of gfal 2.0
group_name : group name of the parameter
key : key of the parameter
error : GError error report system
Returns:
parameter value
gint gfal2_get_opt_integer_with_default ( gfal2_context_t  context,
const gchar *  group_name,
const gchar *  key,
gint  default_value 
)

similar to gfal2_get_opt_integer but return a default value if an error occures

Parameters:
handle : context of gfal 2.0
group_name : group name of the parameter
key : key of the parameter
default_value : default value returned if not present
Returns:
parameter value
gchar* gfal2_get_opt_string ( gfal2_context_t  handle,
const gchar *  group_name,
const gchar *  key,
GError **  error 
)

get a string parameter in the current GFAL 2.0 configuration see gfal2.d configuration files or gfal 2.0 documentation to know group/key/values

Parameters:
handle : context of gfal 2.0
group_name : group name of the parameter
key : key of the parameter
error : GError error report system
Returns:
parameter value
gchar** gfal2_get_opt_string_list ( gfal_handle  handle,
const gchar *  group_name,
const gchar *  key,
gsize *  length,
GError **  error 
)

get a list of string parameter in the current GFAL 2.0 configuration see gfal2.d configuration files or gfal 2.0 documentation to know group/key/values

Parameters:
handle : context of gfal 2.0
group_name : group name of the parameter
key : key of the parameter
error : GError error report system
Returns:
parameter value
gint gfal2_set_opt_boolean ( gfal2_context_t  handle,
const gchar *  group_name,
const gchar *  key,
gboolean  value,
GError **  error 
)

set a boolean parameter in the current GFAL 2.0 configuration see gfal2.d configuration files or gfal 2.0 documentation to know group/key/values

Parameters:
handle : context of gfal 2.0
group_name : group name of the parameter
key : key of the parameter
value : value to set
error : GError error report system
Returns:
parameter value
gint gfal2_set_opt_integer ( gfal2_context_t  handle,
const gchar *  group_name,
const gchar *  key,
gint  value,
GError **  error 
)

set an integer parameter in the current GFAL 2.0 configuration see gfal2.d configuration files or gfal 2.0 documentation to know group/key/values

Parameters:
handle : context of gfal 2.0
group_name : group name of the parameter
key : key of the parameter
value : value to set
error : GError error report system
Returns:
parameter value
gint gfal2_set_opt_string ( gfal2_context_t  handle,
const gchar *  group_name,
const gchar *  key,
gchar *  value,
GError **  error 
)

set a string parameter in the current GFAL 2.0 configuration see gfal2.d configuration files or gfal 2.0 documentation to know group/key/values

Parameters:
handle : context of gfal 2.0
group_name : group name of the parameter
key : key of the parameter
value : value to set
error : GError error report system
Returns:
parameter value
gint gfal2_set_opt_string_list ( gfal_handle  handle,
const gchar *  group_name,
const gchar *  key,
const gchar *const   list[],
gsize  length,
GError **  error 
)

set a list of string parameter in the current GFAL 2.0 configuration see gfal2.d configuration files or gfal 2.0 documentation to know group/key/values

Parameters:
handle : context of gfal 2.0
group_name : group name of the parameter
key : key of the parameter
value : value to set
error : GError error report system
Returns:
parameter value

Generated on 28 Nov 2013 for GFAL2 by  doxygen 1.6.1