Documentation/English (British)/developer-chapter3-editfilter.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.38: editfilter</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.38 editfilter</span><br><br>\r
  19 \r
  20 Edits a filter in the filter database.<br><br>\r
  21 \r
  22 <span class="heading">Parameters:</span><br><br>\r
  23 \r
  24 <div class="code">\r
  25     $kiriwrite_dbmodule->editfilter(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->connectfilter();<br>\r
  34     $kiriwrite_dbmodule->editfilter({ FilterID => 1, NewFindFilter => “The new find filter setting.”, NewReplaceFilter => “The new replace filter setting.”, NewFilterPriority => 2, NewEnabled => 1, NewFilterNotes => “The new notes of the filter.” });\r
  35 </div>\r
  36 \r
  37 options<br>\r
  38 Specifies the following options as a hash in any order.<br><br>\r
  39 \r
  40 <table class="infotable">\r
  41     <tr>\r
  42         <td class="tableheading">Value</td>\r
  43         <td class="tableheading">Description</td>\r
  44     </tr>\r
  45     <tr>\r
  46         <td class="tabledata">FilterID</td>\r
  47         <td class="tabledata">Specifies the filter with the identification number to edit.</td>\r
  48     </tr>\r
  49     <tr>\r
  50         <td class="tabledata">NewFindFilter</td>\r
  51         <td class="tabledata">Specifies the new find filter setting.</td>\r
  52     </tr>\r
  53     <tr>\r
  54         <td class="tabledata">NewReplaceFilter</td>\r
  55         <td class="tabledata">Specifies the new replace filter setting.</td>\r
  56     </tr>\r
  57     <tr>\r
  58         <td class="tabledata">NewFilterPriority</td>\r
  59         <td class="tabledata">Specifies the new filter priority setting.</td>\r
  60     </tr>\r
  61     <tr>\r
  62         <td class="tabledata">NewEnabled</td>\r
  63         <td class="tabledata">Specifies if the filter should be used when compiling.</td>\r
  64     </tr>\r
  65     <tr>\r
  66         <td class="tabledata">NewFilterNotes</td>\r
  67         <td class="tabledata">Specifies the new filter notes.</td>\r
  68     </tr>\r
  69 </table>\r
  70 \r
  71 <br>\r
  72 \r
  73 If the filter with the filter identification number given does not exist then the error returned should be 'FilterDoesNotExist' in the $error scalar.<br><br>\r
  74 \r
  75 If (when using the file-based database module) the filter database has invalid permissions set then the error returned should be 'FilterDatabaseInvalidPermissionsSet' in the $error scalar.<br><br>\r
  76 \r
  77 If a database error occurs while editing the filter in the filter database then the error returned should be 'FilterDatabaseError' in the $error scalar and information about the error should be in the $errorext scalar.\r
  78                 </div>\r
  79         </body>\r
  80 </html>\r