summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/en/weechat_plugin_api.en.asciidoc41
-rw-r--r--doc/fr/weechat_plugin_api.fr.asciidoc42
-rw-r--r--doc/it/weechat_plugin_api.it.asciidoc44
-rw-r--r--doc/ja/weechat_plugin_api.ja.asciidoc44
4 files changed, 171 insertions, 0 deletions
diff --git a/doc/en/weechat_plugin_api.en.asciidoc b/doc/en/weechat_plugin_api.en.asciidoc
index 2398e45e7..823f80252 100644
--- a/doc/en/weechat_plugin_api.en.asciidoc
+++ b/doc/en/weechat_plugin_api.en.asciidoc
@@ -1818,6 +1818,47 @@ length = weechat_string_decode_base64 (string, result);
[NOTE]
This function is not available in scripting API.
+==== string_hex_dump
+
+_WeeChat ≥ 1.4._
+
+Display a dump of data as hexadecimal and ascii bytes.
+
+Prototype:
+
+[source,C]
+----
+char *string_hex_dump (const char *data, int data_size, int bytes_per_line,
+ const char *prefix, const char *suffix);
+----
+
+Arguments:
+
+* 'data': the data to dump
+* 'data_size': number of bytes to dump in 'data'
+* 'bytes_per_line': number of bytes to display in each line
+* 'prefix': the prefix to display at the beginning of each line
+ (optional, can be NULL)
+* 'suffix': the suffix to display at the end of each line
+ (optional, can be NULL)
+
+Return value:
+
+* string with dump of data (must be freed by calling "free" after use)
+
+C example:
+
+[source,C]
+----
+char *string = "abc def-ghi";
+char *dump = weechat_string_hex_dump (string, strlen (string), 8, " >> ", NULL);
+/* dump == " >> 61 62 63 20 64 65 66 2D a b c d e f - \n"
+ " >> 67 68 69 g h i " */
+----
+
+[NOTE]
+This function is not available in scripting API.
+
==== string_is_command_char
_WeeChat ≥ 0.3.2._
diff --git a/doc/fr/weechat_plugin_api.fr.asciidoc b/doc/fr/weechat_plugin_api.fr.asciidoc
index a5895d68a..c769281e6 100644
--- a/doc/fr/weechat_plugin_api.fr.asciidoc
+++ b/doc/fr/weechat_plugin_api.fr.asciidoc
@@ -1851,6 +1851,48 @@ length = weechat_string_decode_base64 (string, result);
[NOTE]
Cette fonction n'est pas disponible dans l'API script.
+==== string_hex_dump
+
+_WeeChat ≥ 1.4._
+
+Afficher les données sous forme d'octets en hexadécimal et ascii.
+
+Prototype :
+
+[source,C]
+----
+char *string_hex_dump (const char *data, int data_size, int bytes_per_line,
+ const char *prefix, const char *suffix);
+----
+
+Paramètres :
+
+* 'data' : les données à afficher
+* 'data_size' : nombre d'octets à afficher dans 'data'
+* 'bytes_per_line' : nombre d'octets à afficher sur chaque ligne
+* 'prefix' : le préfixe à afficher au début de chaque ligne
+ (optionnel, peut être NULL)
+* 'suffix' : le suffixe à afficher à la fin de chaque ligne
+ (optionnel, peut être NULL)
+
+Valeur de retour :
+
+* chaîne avec les données (doit être supprimée par un appel à "free" après
+ utilisation)
+
+Exemple en C :
+
+[source,C]
+----
+char *string = "abc def-ghi";
+char *dump = weechat_string_hex_dump (string, strlen (string), 8, " >> ", NULL);
+/* dump == " >> 61 62 63 20 64 65 66 2D a b c d e f - \n"
+ " >> 67 68 69 g h i " */
+----
+
+[NOTE]
+Cette fonction n'est pas disponible dans l'API script.
+
==== string_is_command_char
_WeeChat ≥ 0.3.2._
diff --git a/doc/it/weechat_plugin_api.it.asciidoc b/doc/it/weechat_plugin_api.it.asciidoc
index 07df84698..f0d3fe226 100644
--- a/doc/it/weechat_plugin_api.it.asciidoc
+++ b/doc/it/weechat_plugin_api.it.asciidoc
@@ -1882,6 +1882,50 @@ length = weechat_string_decode_base64 (string, result);
[NOTE]
Questa funzione non è disponibile nelle API per lo scripting.
+==== string_hex_dump
+
+_WeeChat ≥ 1.4._
+
+// TRANSLATION MISSING
+Display a dump of data as hexadecimal and ascii bytes.
+
+Prototipo:
+
+[source,C]
+----
+char *string_hex_dump (const char *data, int data_size, int bytes_per_line,
+ const char *prefix, const char *suffix);
+----
+
+Argomenti:
+
+// TRANSLATION MISSING
+* 'data': the data to dump
+* 'data_size': number of bytes to dump in 'data'
+* 'bytes_per_line': number of bytes to display in each line
+* 'prefix': the prefix to display at the beginning of each line
+ (optional, can be NULL)
+* 'suffix': the suffix to display at the end of each line
+ (optional, can be NULL)
+
+Valore restituito:
+
+// TRANSLATION MISSING
+* string with dump of data (must be freed by calling "free" after use)
+
+Esempio in C:
+
+[source,C]
+----
+char *string = "abc def-ghi";
+char *dump = weechat_string_hex_dump (string, strlen (string), 8, " >> ", NULL);
+/* dump == " >> 61 62 63 20 64 65 66 2D a b c d e f - \n"
+ " >> 67 68 69 g h i " */
+----
+
+[NOTE]
+Questa funzione non è disponibile nelle API per lo scripting.
+
==== string_is_command_char
_WeeChat ≥ 0.3.2._
diff --git a/doc/ja/weechat_plugin_api.ja.asciidoc b/doc/ja/weechat_plugin_api.ja.asciidoc
index f7f17fb9c..e888da021 100644
--- a/doc/ja/weechat_plugin_api.ja.asciidoc
+++ b/doc/ja/weechat_plugin_api.ja.asciidoc
@@ -1819,6 +1819,50 @@ length = weechat_string_decode_base64 (string, result);
[NOTE]
スクリプト API ではこの関数を利用できません。
+==== string_hex_dump
+
+_WeeChat ≥ 1.4._
+
+// TRANSLATION MISSING
+Display a dump of data as hexadecimal and ascii bytes.
+
+プロトタイプ:
+
+[source,C]
+----
+char *string_hex_dump (const char *data, int data_size, int bytes_per_line,
+ const char *prefix, const char *suffix);
+----
+
+引数:
+
+// TRANSLATION MISSING
+* 'data': the data to dump
+* 'data_size': number of bytes to dump in 'data'
+* 'bytes_per_line': number of bytes to display in each line
+* 'prefix': the prefix to display at the beginning of each line
+ (optional, can be NULL)
+* 'suffix': the suffix to display at the end of each line
+ (optional, can be NULL)
+
+戻り値:
+
+// TRANSLATION MISSING
+* string with dump of data (must be freed by calling "free" after use)
+
+C 言語での使用例:
+
+[source,C]
+----
+char *string = "abc def-ghi";
+char *dump = weechat_string_hex_dump (string, strlen (string), 8, " >> ", NULL);
+/* dump == " >> 61 62 63 20 64 65 66 2D a b c d e f - \n"
+ " >> 67 68 69 g h i " */
+----
+
+[NOTE]
+スクリプト API ではこの関数を利用できません。
+
==== string_is_command_char
_WeeChat バージョン 0.3.2 以上で利用可。_