Updated the documentation.

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

diff --git a/Documentation/English (British)/developer-chapter3-gettemplatelist.html b/Documentation/English (British)/developer-chapter3-gettemplatelist.html
index 181ad1a..8e86526 100644 (file)
--- a/Documentation/English (British)/developer-chapter3-gettemplatelist.html
+++ b/Documentation/English (British)/developer-chapter3-gettemplatelist.html
@@ -22,7 +22,7 @@ Gets the list of templates. The information is returned as an array.<br><br>
 <span class="heading">Parameters:</span><br><br>\r
 \r
 <div class="code">\r
-    $kiriwrite_dbmodule->gettemplatelist();\r
+    $kiriwrite_dbmodule->gettemplatelist(<i>options</i>);\r
 </div>\r
 \r
 <br>\r
@@ -30,11 +30,31 @@ Gets the list of templates. The information is returned as an array.<br><br>
 <span class="heading">Usage:</span><br><br>\r
 \r
 <div class="code">\r
-    $kiriwrite_dbmodule->gettemplatelist();\r
+    $kiriwrite_dbmodule->gettemplatelist({ StartFrom => 0, Limit => 50 });\r
 </div>\r
 \r
 <br>\r
 \r
+<i>options</i><br>\r
+Specifies the following options as a hash (in any order).<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 template entry to start from.</td>\r
+    </tr>\r
+    <tr>\r
+        <td class="tabledata">Limit</td>\r
+        <td class="tabledata">Specifies how many templates should be retrieved.</td>\r
+    </tr>\r
+</table>\r
+\r
+<br>\r
+\r
 If a database error occurs while getting the list of templates then the error returned should be 'TemplateDatabaseError' in the $error scalar and the information about the error should be placed in the $errorext scalar.\r
                </div>\r
        </body>\r