1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
\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
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
17 <div class="pageinformation">
\r
18 <span class="pagetitle">3.16 adddatabase</span><br><br>
\r
20 Adds a database.<br><br>
\r
22 <span class="heading">Parameters:</span><br><br>
\r
25 $kiriwrite_dbmodule->adddatabase(options);
\r
30 <span class="heading">Usage:</span><br><br>
\r
33 $kiriwrite_dbmodule->adddatabase({ DatabaseFilename => "database", DatabaseName => "Database Name", DatabaseDescription => "Database Description", DatabaseNotes => "Some notes about the database", DatabaseCategories => "database, new, categories", VersionMajor => 0, VersionMinor => 4, VersionRevision => 0 });
\r
39 Specifies the following options as a hash in any order.<br><br>
\r
41 <table class="infotable">
\r
43 <td class="tableheading">Value</td>
\r
44 <td class="tableheading">Description</td>
\r
47 <td class="tabledata">DatabaseFilename</td>
\r
48 <td class="tabledata">Specifies the filename of the new database.</td>
\r
51 <td class="tabledata">DatabaseName</td>
\r
52 <td class="tabledata">Specifies the name of the new database.</td>
\r
55 <td class="tabledata">DatabaseDescription</td>
\r
56 <td class="tabledata">Specifies the description of the new database.</td>
\r
59 <td class="tabledata">DatabaseNotes</td>
\r
60 <td class="tabledata">Specifies the notes of the new database.</td>
\r
63 <td class="tabledata">DatabaseCategories</td>
\r
64 <td class="tabledata">Specifies the categories of the new database.</td>
\r
67 <td class="tabledata">VersionMajor</td>
\r
68 <td class="tabledata">Specifies the major version number of the new database.</td>
\r
71 <td class="tabledata">VersionMinor</td>
\r
72 <td class="tabledata">Specifies the minor version number of the new database.</td>
\r
75 <td class="tabledata">VersionRevision</td>
\r
76 <td class="tabledata">Specifies the revision version number of the new database.</td>
\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
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