api: add function config_option_get_string in plugin API

1 files changed, 41 insertions, 0 deletions

diff --git a/doc/fr/weechat_plugin_api.fr.adoc b/doc/fr/weechat_plugin_api.fr.adoc
index d8e635b81..67b27a493 100644
--- a/doc/fr/weechat_plugin_api.fr.adoc
+++ b/doc/fr/weechat_plugin_api.fr.adoc
@@ -6154,6 +6154,47 @@ weechat.config_option_rename(option, new_name)
 weechat.config_option_rename(option, "nouveau_nom")
 ----
 
+==== config_option_get_string
+
+_WeeChat ≥ 1.9._
+
+Retourner la valeur d'une propriété de l'option sous forme de chaîne.
+
+Prototype :
+
+[source,C]
+----
+const char *weechat_config_option_get_string (struct t_config_option *option,
+                                              const char *property);
+----
+
+Paramètres :
+
+* _option_ : pointeur vers l'option
+* _property_ : nom de la propriété :
+** _name_ : nom de l'option
+** _parent_name_ : nom de l'option parente
+** _type_ : type de l'option, un parmi ceux-ci :
+*** _boolean_
+*** _integer_
+*** _string_
+*** _color_
+** _description_ : description de l'option
+
+Valeur de retour :
+
+* valeur de la propriété, sous forme de chaîne
+
+Exemple en C :
+
+[source,C]
+----
+const char *type = weechat_config_option_get_string (option, "type");
+----
+
+[NOTE]
+Cette fonction n'est pas disponible dans l'API script.
+
 ==== config_option_get_pointer
 
 Retourner un pointeur vers une propriété de l'option.