api: add function list_user_data (issue #666)

1 files changed, 31 insertions, 0 deletions

diff --git a/doc/en/weechat_plugin_api.en.adoc b/doc/en/weechat_plugin_api.en.adoc
index 3e5fec305..f076adcd1 100644
--- a/doc/en/weechat_plugin_api.en.adoc
+++ b/doc/en/weechat_plugin_api.en.adoc
@@ -4071,6 +4071,37 @@ value = weechat.list_string(item)
 weechat.prnt("", "value of item: %s" % weechat.list_string(item))
 ----
 
+==== list_user_data
+
+_WeeChat ≥ 2.6._
+
+Return pointer to the user data of an item.
+
+Prototype:
+
+[source,C]
+----
+void *weechat_list_user_data (struct t_weelist_item *item);
+----
+
+Arguments:
+
+* _item_: item pointer
+
+Return value:
+
+* pointer to the user data of item
+
+C example:
+
+[source,C]
+----
+weechat_printf (NULL, "user data of item: 0x%lx", weechat_list_user_data (item));
+----
+
+[NOTE]
+This function is not available in scripting API.
+
 ==== list_size
 
 Return size of list (number of items).