Home | News | Projects | Releases
Bugs | RFE | Repositories | Help
Removed white-space: nowrap from textarea CSS property.
[kiriwrite/.git] / Documentation / English (British) / developer-chapter3-editdatabase.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.17: editdatabase</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.17 editdatabase</span><br><br>\r
19 \r
20 Edits a database.<br><br>\r
21 \r
22 <span class="heading">Parameters:</span><br><br>\r
23 \r
24 <div class="code">\r
25     $kiriwrite_dbmodule->editdatabase(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     $kiriwrite_dbmodule->editdatabase({ DatabaseNewFilename => &quot;newdatabase&quot;, DatabaseName => &quot;New Database Name&quot;, DatabaseDescription => &quot;New Database Description&quot;, DatabaseNotes => &quot;New Database Notes&quot;, DatabaseCategories => &quot;new, database, categories&quot; });\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">DatabaseNewFilename</td>\r
49         <td class="tabledata">Specifies the new filename of the database.</td>\r
50     </tr>\r
51     <tr>\r
52         <td class="tabledata">DatabaseName</td>\r
53         <td class="tabledata">Specifies the new database name.</td>\r
54     </tr>\r
55     <tr>\r
56         <td class="tabledata">DatabaseDescription</td>\r
57         <td class="tabledata">Specifies the new database description.</td>\r
58     </tr>\r
59     <tr>\r
60         <td class="tabledata">DatabaseNotes</td>\r
61         <td class="tabledata">Specifies the new notes.</td>\r
62     </tr>\r
63     <tr>\r
64         <td class="tabledata">DatebaseCategories</td>\r
65         <td class="tabledata">Specifies the new categories.</td>\r
66     </tr>\r
67 </table>\r
68 \r
69 <br>\r
70 \r
71 If a database is edited but the filename already exists (after checking if it does exist using the dbexists subroutine) then the error returned should be 'DatabaseExists' in the $error scalar.<br><br>\r
72 \r
73 If a database error occurs while editing the database, the error returned should be 'DatabaseError' in the $error scalar and the information about the error placed in the $errorext scalar.<br><br>\r
74 \r
75 If (when using a file-based database module) the database module can't be edited because of invalid permissions set then the error returned should be 'InvalidPermissionsSet' in the $error scalar.\r
76                 </div>\r
77         </body>\r
78 </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