Documentation/English (British)/developer-chapter1-variablecheck.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 - 1.9 xestiascan_variablecheck</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">1.9 xestiascan_variablecheck</span>\r
  19 <br><br>\r
  20 xestiascan_variablecheck checks variables that are passed to it to see if the content of that variable is valid and returns an error if it isn’t. All the parameters are needed each time the subroutine is called and if the noerror parameters is set to 1 then a value is returned when an error occurs. Otherwise, a standard error will be given.\r
  21 <br><br>\r
  22 <b>Parameters:</b>\r
  23 <br><br>\r
  24 <div class="code">\r
  25 xestiascan_variablecheck(variable, type, option, noerror);\r
  26 </div>\r
  27 <br><br>\r
  28 <b>Usage:</b>\r
  29 <br><br>\r
  30 <div class="code">\r
  31 xestiascan_variablecheck(“Test 123”, “lettersnumbers”, “”, 0);<br>\r
  32 $letters_letnum_check = xestiascan_variablecheck(“Test 123”, “lettersnumbers”, “”, 1);\r
  33 </div>\r
  34 <br><br>\r
  35 <table class="infotable">\r
  36  <tr>\r
  37   <td class="tableheading">Value</td>\r
  38   <td class="tableheading">Description</td>\r
  39  </tr>\r
  40  <tr>\r
  41   <td class="tabledata">numbers</td>\r
  42   <td class="tabledata">Check if the variable given only contains characters.</td>\r
  43  </tr>\r
  44  <tr>\r
  45   <td class="tabledata">decimal</td>\r
  46   <td class="tabledata">Check if the variable given is a valid decimal number.</td>\r
  47  </tr>\r
  48  <tr>\r
  49   <td class="tabledata">lettersnumbers</td>\r
  50   <td class="tabledata">Check if the variable given only contains letters and numbers.</td>\r
  51  </tr>\r
  52  <tr>\r
  53   <td class="tabledata">maxlength</td>\r
  54   <td class="tabledata">Check if the variable given does not exceed the specific length given.</td>\r
  55  </tr>\r
  56  <tr>\r
  57   <td class="tabledata">blank</td>\r
  58   <td class="tabledata">Check if the variable given is blank.</td>\r
  59  </tr>\r
  60  <tr>\r
  61   <td class="tabledata">filename</td>\r
  62   <td class="tabledata">Check if the variable given is a valid filename.</td>\r
  63  </tr>\r
  64  <tr>\r
  65   <td class="tabledata">filenameindir</td>\r
  66   <td class="tabledata">Check if the variable given is a valid filename in a directory.</td>\r
  67  </tr>\r
  68  <tr>\r
  69   <td class="tabledata">datetime</td>\r
  70   <td class="tabledata">Check if the variable given is a valid date and time format.</td>\r
  71  </tr>\r
  72  <tr>\r
  73   <td class="tabledata">directory</td>\r
  74   <td class="tabledata">Check if the variable given is a valid directory name.</td>\r
  75  </tr>\r
  76  <tr>\r
  77   <td class="tabledata">language_filename</td>\r
  78   <td class="tabledata">Check if the variable given is a valid language filename.</td>\r
  79  </tr>\r
  80  <tr>\r
  81   <td class="tabledata">module</td>\r
  82   <td class="tabledata">Check if the variable given is a valid module name.</td>\r
  83  </tr>\r
  84  <tr>\r
  85   <td class="tabledata">utf8</td>\r
  86   <td class="tabledata">Check if the variable given is a correctly formatted UTF8 string.</td>\r
  87  </tr>\r
  88  <tr>\r
  89   <td class="tabledata">serverprotocol</td>\r
  90   <td class="tabledata">Checks to see if the variable given contains a valid server protocol (TCP or UDP).</td>\r
  91  </tr>\r
  92  <tr>\r
  93   <td class="tabledata">port</td>\r
  94   <td class="tabledata">Check to see if the port number given is a valid port number (0-65535)</td>\r
  95  </tr>\r
  96 </table>\r
  97 <br><br>\r
  98 <i>option</i><br>\r
  99 Specifies the setting to be used with the test.\r
 100 <br><br>\r
 101 <i>noerror</i><br>\r
 102 Specifies if no error message should be returned but a value should be returned instead so that a more specific error message can be used.\r
 103 <br><br>\r
 104 For more information on what values are returned, please look at the xestiascan_error subroutine in the Kiriwrite source code.\r
 105                 </div>\r
 106         </body>\r
 107 </html>\r