Documentation/English (British)/developer-chapter3-loadsettings.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.3: loadsettings</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.3 loadsettings</span><br><br>\r
  19 \r
  20 Loads the settings needed for the database module.<br><br>\r
  21 \r
  22 <span class="heading">Parameters:</span><br><br>\r
  23 \r
  24 <div class="code">\r
  25     $kiriwrite_dbmodule->loadsettings(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->loadsettings({ Directory => &quot;db&quot;, DateTime => &quot;DD/MM/YY (hh:mm:ss)&quot;, Server => &quot;localhost&quot;, Port => &quot;3306&quot;, Protocol => &quot;tcp&quot;, Database => &quot;database&quot;, Username => &quot;username&quot;, Password => &quot;password&quot;, TablePrefix => &quot;tableprefix&quot; });\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">Directory</td>\r
  48         <td class="tabledata">Specifies the directory where the databases are stored.</td>\r
  49     </tr>\r
  50     <tr>\r
  51         <td class="tabledata">DateTime</td>\r
  52         <td class="tabledata">Specifies the date and time settings to use.</td>\r
  53     </tr>\r
  54     <tr>\r
  55         <td class="tabledata">Server</td>\r
  56         <td class="tabledata">Specifies the location of the server.</td>\r
  57     </tr>\r
  58     <tr>\r
  59         <td class="tabledata">Port</td>\r
  60         <td class="tabledata">Specifies the port number of the server.</td>\r
  61     </tr>\r
  62     <tr>\r
  63         <td class="tabledata">Protocol</td>\r
  64         <td class="tabledata">Specifies the protocol type to use.</td>\r
  65     </tr>\r
  66     <tr>\r
  67         <td class="tabledata">Database</td>\r
  68         <td class="tabledata">Specifies the name of the database to use.</td>\r
  69     </tr>\r
  70     <tr>\r
  71         <td class="tabledata">Username</td>\r
  72         <td class="tabledata">Specifies the username to use.</td>\r
  73     </tr>\r
  74     <tr>\r
  75         <td class="tabledata">Password</td>\r
  76         <td class="tabledata">Specifies the password to use.</td>\r
  77     </tr>\r
  78     <tr>\r
  79         <td class="tabledata">TablePrefix</td>\r
  80         <td class="tabledata">Specifies the table prefix to use.</td>\r
  81     </tr>\r
  82 </table>\r
  83 \r
  84 <br>\r
  85 \r
  86 Typically all the settings except for Directory are used by a server-based database module, while only the Directory and DateTime settings will be used by a file-based database module.\r
  87                 </div>\r
  88         </body>\r
  89 </html>\r