Documentation/English (British)/developer-chapter3-addfilter.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.37: addfilter</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.37 addfilter</span><br><br>\r
  19 \r
  20 Adds a filter to 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->addfilter(options);\r
  26 </div>\r
  27 \r
  28 <span class="heading">Usage:</span><br><br>\r
  29 \r
  30 <div class="code">\r
  31     $kiriwrite_dbmodule->connectfilter(1);\r
  32     $kiriwrite_dbmodule->addfilter({ FindFilter => “This is the find filter.”, ReplaceFilter => “This is the replace filter.”, Priority => 1, Enabled => 1, Notes => “Some notes about the filter.” });\r
  33 </div>\r
  34 \r
  35 <br>\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">FindFilter</td>\r
  47         <td class="tabledata">Specifies the find filter setting of the new filter.</td>\r
  48     </tr>\r
  49     <tr>\r
  50         <td class="tabledata">ReplaceFilter</td>\r
  51         <td class="tabledata">Specifies the replace filter setting of the new filter.</td>\r
  52     </tr>\r
  53     <tr>\r
  54         <td class="tabledata">Priority</td>\r
  55         <td class="tabledata">Specifies the priority setting of the new filter.</td>\r
  56     </tr>\r
  57     <tr>\r
  58         <td class="tabledata">Enabled</td>\r
  59         <td class="tabledata">Specifies if the filter should be used when compiling.</td>\r
  60     </tr>\r
  61     <tr>\r
  62         <td class="tabledata">Notes</td>\r
  63         <td class="tabledata">Specifies the notes for the new filter.</td>\r
  64     </tr>\r
  65 </table>\r
  66 \r
  67 <br>\r
  68 \r
  69 If the filter database cannot be created when adding a filter and the filter database doesn't already exist then the error returned should be 'FilterDatabaseFileUncreatable' in the $error scalar.<br><br>\r
  70 \r
  71 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.\r
  72                 </div>\r
  73         </body>\r
  74 </html>\r