Updated the documentation.

[kiriwrite/.git] / Documentation / English (British) / developer-chapter3-getfilterlist.html

diff --git a/Documentation/English (British)/developer-chapter3-getfilterlist.html b/Documentation/English (British)/developer-chapter3-getfilterlist.html
index 6e05257..2b43660 100644 (file)
--- a/Documentation/English (British)/developer-chapter3-getfilterlist.html
+++ b/Documentation/English (British)/developer-chapter3-getfilterlist.html
@@ -22,7 +22,7 @@ Gets the list of available filters. Returns the list of filters as an array.<br>
 <span class="heading">Parameters:</span><br><br>\r
 \r
 <div class="code">\r
-    $kiriwrite_dbmodule->getfilterlist();\r
+    $kiriwrite_dbmodule->getfilterlist(<i>options</i>);\r
 </div>\r
 \r
 <br>\r
@@ -31,9 +31,26 @@ Gets the list of available filters. Returns the list of filters as an array.<br>
 \r
 <div class="code">\r
     $kiriwrite_dbmodule->connectfilter();<br>\r
-    @filterlist = $kiriwrite_dbmodule->getfilterlist();\r
+    @filterlist = $kiriwrite_dbmodule->getfilterlist({ StartFrom => 0, Limit => 50 });\r
 </div>\r
 \r
+<br><br>\r
+\r
+<table class="infotable">\r
+    <tr>\r
+        <td class="tableheading">Value</td>\r
+        <td class="tableheading">Description</td>\r
+    </tr>\r
+    <tr>\r
+        <td class="tabledata">StartFrom</td>\r
+        <td class="tabledata">Specifies which filter entry to start from.</td>\r
+    </tr>\r
+    <tr>\r
+        <td class="tabledata">Limit</td>\r
+        <td class="tabledata">Specifies how many filters should be retrieved.</td>\r
+    </tr>\r
+</table>\r
+\r
 <br>\r
 \r
 If a database error occurs while getting the list of filters from the filter database then the error returned should be 'FilterDatabaseError' in the $error scalar and information about the error should be in the $errorext scalar.\r