Documentation/English (British)/developer-chapter5-getoptions.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 - 5.5 getoptions</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="pagetitle">5.5 getoptions</span>\r
  19 <br><br>\r
  20 Gets the options available for the export module.\r
  21 <br><br>\r
  22 <b>Parameters:</b>\r
  23 <br><br>\r
  24 <div class="code">\r
  25 $xestiascan_exportmodule->getoptions();\r
  26 </div>\r
  27 <br><br>\r
  28 <b>Usage:</b>\r
  29 <br><br>\r
  30 <div class="code">\r
  31 %options = $xestiascan_exportmodule->getoptions();\r
  32 </div>\r
  33 <br><br>\r
  34 Places the following settings as a hash. Each setting has the following values with the short name for the value.\r
  35 <br><br>\r
  36 <table class="infotable">\r
  37  <tr>\r
  38   <td class="tableheading">Setting</td>\r
  39   <td class="tableheading">Description</td>\r
  40  </tr>\r
  41  <tr>\r
  42   <td class="tabledata">type</td>\r
  43   <td class="tabledata">Specifies the type of setting. Either checkbox, textbox, combobox or radio.</td>\r
  44  </tr>\r
  45  <tr>\r
  46   <td class="tabledata">string</td>\r
  47   <td class="tabledata">Specifies the description of the setting.</td>\r
  48  </tr>\r
  49  <tr>\r
  50   <td class="tabledata">checked</td>\r
  51   <td class="tabledata">Specifies if the option is checked for a checkbox type setting.</td>\r
  52  </tr>\r
  53  <tr>\r
  54   <td class="tabledata">size</td>\r
  55   <td class="tabledata">Specifies the size of the textbox.</td>\r
  56  </tr>\r
  57  <tr>\r
  58   <td class="tabledata">maxlength</td>\r
  59   <td class="tabledata">Specifies the maximum length of the textbox.</td>\r
  60  </tr>\r
  61  <tr>\r
  62   <td class="tabledata">value</td>\r
  63   <td class="tabledata">Specifies the default value of the textbox or the values of the combo box. Each value for the combobox should be seperated with a pipe (‘|’) symbol.</td>\r
  64  </tr>\r
  65  <tr>\r
  66   <td class="tabledata">password</td>\r
  67   <td class="tabledata">Specifies if the textbox is a password field.</td>\r
  68  </tr>\r
  69  <tr>\r
  70   <td class="tabledata">selected</td>\r
  71   <td class="tabledata">Specifies if the radio option is selected.</td>\r
  72  </tr>\r
  73 </table>\r
  74                 </div>\r
  75         </body>\r
  76 </html>\r