From fdf827d31f655f693e4273a23538c5d605f71931 Mon Sep 17 00:00:00 2001
From: Sebastien Helleu <flashcode@flashtux.org>
Date: Sat, 15 Nov 2008 18:28:36 +0100
Subject: Add function utf8_strndup to C plugin API

---
 doc/en/dev/plugin_c_api.en.xml | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

(limited to 'doc/en/dev')

diff --git a/doc/en/dev/plugin_c_api.en.xml b/doc/en/dev/plugin_c_api.en.xml
index 3b35e5713..f4eb5b150 100644
--- a/doc/en/dev/plugin_c_api.en.xml
+++ b/doc/en/dev/plugin_c_api.en.xml
@@ -1545,6 +1545,42 @@ char *weechat_utf8_pos (const char *string, int real_pos);
       </para>
     </section>
     
+    <section id="secPluginCApi_weechat_utf8_strndup">
+      <title>weechat_utf8_strndup</title>
+      
+      <para>
+        Prototype:
+<programlisting>
+char *weechat_utf8_strndup (const char *string, int max_chars);
+</programlisting>
+      </para>
+      <para>
+        Return duplicate string, with max N chars.
+      </para>
+      <para>
+        Arguments:
+        <itemizedlist>
+          <listitem>
+            <para>
+              <option>string</option>: string
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              <option>max_chars</option>: max chars
+            </para>
+          </listitem>
+        </itemizedlist>
+      </para>
+      <para>
+        Return value: duplicated string, NULL if error.
+      </para>
+      <para>
+        Example:
+        <screen>char *string = weechat_utf8_strndup ("chêne", 3); /* returns "chê" */</screen>
+      </para>
+    </section>
+    
   </section>
   
   <!-- ===========================[ directories ]========================== -->
-- 
cgit v1.2.3