Documentation/English (British)/developer-chapter3-adddatabase.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.16: adddatabase</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.16 adddatabase</span><br><br>\r
  19 \r
  20 Adds 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->adddatabase(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->adddatabase({ DatabaseFilename => &quot;database&quot;, DatabaseName => &quot;Database Name&quot;, DatabaseDescription => &quot;Database Description&quot;, DatabaseNotes => &quot;Some notes about the database&quot;, DatabaseCategories => &quot;database, new, categories&quot;, VersionMajor => 0, VersionMinor => 4, VersionRevision => 0 });\r
  34 </div>\r
  35 \r
  36 <br>\r
  37 \r
  38 options<br>\r
  39 Specifies the following options as a hash in any order.<br><br>\r
  40 \r
  41 <table class="infotable">\r
  42     <tr>\r
  43         <td class="tableheading">Value</td>\r
  44         <td class="tableheading">Description</td>\r
  45     </tr>\r
  46     <tr>\r
  47         <td class="tabledata">DatabaseFilename</td>\r
  48         <td class="tabledata">Specifies the filename of the new database.</td>\r
  49     </tr>\r
  50     <tr>\r
  51         <td class="tabledata">DatabaseName</td>\r
  52         <td class="tabledata">Specifies the name of the new database.</td>\r
  53     </tr>\r
  54     <tr>\r
  55         <td class="tabledata">DatabaseDescription</td>\r
  56         <td class="tabledata">Specifies the description of the new database.</td>\r
  57     </tr>\r
  58     <tr>\r
  59         <td class="tabledata">DatabaseNotes</td>\r
  60         <td class="tabledata">Specifies the notes of the new database.</td>\r
  61     </tr>\r
  62     <tr>\r
  63         <td class="tabledata">DatabaseCategories</td>\r
  64         <td class="tabledata">Specifies the categories of the new database.</td>\r
  65     </tr>\r
  66     <tr>\r
  67         <td class="tabledata">VersionMajor</td>\r
  68         <td class="tabledata">Specifies the major version number of the new database.</td>\r
  69     </tr>\r
  70     <tr>\r
  71         <td class="tabledata">VersionMinor</td>\r
  72         <td class="tabledata">Specifies the minor version number of the new database.</td>\r
  73     </tr>\r
  74     <tr>\r
  75         <td class="tabledata">VersionRevision</td>\r
  76         <td class="tabledata">Specifies the revision version number of the new database.</td>\r
  77     </tr>\r
  78 </table>\r
  79 \r
  80 <br>\r
  81 \r
  82 If a database is created 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
  83 \r
  84 If a database error occurs while adding the database, the error returned should be 'DatabaseError' in the $error scalar and the information about the error placed in the $errorext scalar.\r
  85                 </div>\r
  86         </body>\r
  87 </html>\r