Home | News | Projects | Releases
Bugs | RFE | Repositories | Help
Changes made in preperation for Kiriwrite 0.4.0
[kiriwrite/.git] / Documentation / English (British) / developer-chapter3-getpageinfo.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">\r
2 <html>\r
3         <head>\r
4                 <link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">\r
5                 <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">\r
6                 <title>Kiriwrite Documentation - Developer Documentation - 3.27: getpageinfo</title>\r
7         </head>\r
8         <body>\r
9                 <div class="menubarback">\r
10                         <div class="menubar">\r
11                                 <span class="apptitle">Kiriwrite</span>\r
12                                 <a href="index.html">Index</a> | <a href="user.html">User \r
13 Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> | \r
14 <a href="developer.html">Developer Documentation</a>\r
15                         </div>\r
16                 </div>\r
17                 <div class="pageinformation">\r
18                         <span class="pagetitle">3.27 getpageinfo</span><br><br>\r
19 \r
20 Gets information about the page. The page information is returned as a hash.<br><br>\r
21 \r
22 <span class="heading">Parameters:</span><br><br>\r
23 \r
24 <div class="code">\r
25     $kiriwrite_dbmodule->getpageinfo(options);\r
26 </div>\r
27 \r
28 <br>\r
29 \r
30 <span class="heading">Usage:</span><br><br>\r
31 \r
32 <div class="code">\r
33     $kiriwrite_dbmodule->selectdb(&quot;database&quot;);<br>\r
34     %pageinfo = $kiriwrite_dbmodule->getpageinfo({ PageFilename => &quot;pagefilename.html&quot;, Reduced => 1 });\r
35 </div>\r
36 \r
37 <br>\r
38 \r
39 options<br>\r
40 Specifies the following options as a hash in any order.<br><br>\r
41 \r
42 <table class="infotable">\r
43     <tr>\r
44         <td class="tableheading">Value</td>\r
45         <td class="tableheading">Description</td>\r
46     </tr>\r
47     <tr>\r
48         <td class="tabledata">PageFilename</td>\r
49         <td class="tabledata">The page filename to get the page information from.</td>\r
50     </tr>\r
51     <tr>\r
52         <td class="tabledata">Reduced</td>\r
53         <td class="tabledata">Returns a reduced version of the page information (page filename, page name, page description and last modified).</td>\r
54     </tr>\r
55 </table>\r
56 \r
57 <br>\r
58 \r
59 If the page with the filename given does not exist then the error returned should be 'PageDoesNotExist' in the $error scalar.<br><br>\r
60 \r
61 If a database error occurs while getting the information about the page in the database then the error returned should be 'DatabaseError' in the $error scalar and information about the error should be in the $errorext scalar.\r
62                 </div>\r
63         </body>\r
64 </html>\r
Xestia Software Development
Yn Maystri
© 2006 - 2019 Xestia Software Development
Software

Xestia Address Book
Xestia Calendar
Development

Xestia Gelforn
Everything else

About
News
Privacy Policy