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>Xestia Scanner Server 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">Xestia Scanner Server</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="code">3.3 loadsettings</span>\r
  19 <br><br>\r
  20 Loads the current Xestia Scanner Server settings into the authentication module.\r
  21 <br><br>\r
  22 <b>Parameters:</b>\r
  23 <br><br>\r
  24 <div class="code">\r
  25 $xestiascan_authmodule->loadsettings(options);\r
  26 </div>\r
  27 <br><br>\r
  28 <b>Usage:</b>\r
  29 <br><br>\r
  30 <div class="code">\r
  31 $xestiascan_authmodule->loadsettings(%options);\r
  32 </div>\r
  33 <br><br>\r
  34 <i>options </i><br>\r
  35 Specifies the settings to use as a hash.\r
  36 <br><br>\r
  37 <table class="infotable">\r
  38  <tr>\r
  39   <td class="tableheading">Setting</td>\r
  40   <td class="tableheading">Description</td>\r
  41  </tr>\r
  42  <tr>\r
  43   <td class="tabledata">DateTime</td>\r
  44   <td class="tabledata">Specifies the date and time format to use.</td>\r
  45  </tr>\r
  46  <tr>\r
  47   <td class="tabledata">Server</td>\r
  48   <td class="tabledata">Specifies the server to use.</td>\r
  49  </tr>\r
  50  <tr>\r
  51   <td class="tabledata">Database</td>\r
  52   <td class="tabledata">Specifies the database to use.</td>\r
  53  </tr>\r
  54  <tr>\r
  55   <td class="tabledata">Username</td>\r
  56   <td class="tabledata">Specifies the username to use.</td>\r
  57  </tr>\r
  58  <tr>\r
  59   <td class="tabledata">Password</td>\r
  60   <td class="tabledata">Specifies the password to use.</td>\r
  61  </tr>\r
  62  <tr>\r
  63   <td class="tabledata">Port</td>\r
  64   <td class="tabledata">Specifies the server port to use.</td>\r
  65  </tr>\r
  66  <tr>\r
  67   <td class="tabledata">Protocol</td>\r
  68   <td class="tabledata">Specifies the protocol to use.</td>\r
  69  </tr>\r
  70  <tr>\r
  71   <td class="tabledata">TablePrefix</td>\r
  72   <td class="tabledata">Specifies the table prefix to use.</td>\r
  73  </tr>\r
  74 </table>\r
  75                 </div>\r
  76         </body>\r
  77 </html>\r