Documentation/English (British)/developer-chapter1-kiriwritecompilecleanhelper.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 - 1.26: kiriwrite_compile_clean_helper</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">1.26 kiriwrite_compile_clean_helper</span><br><br>\r
  19 \r
  20 kiriwrite_compile_clean_helper is a helper subroutine for the kiriwrite_compile_clean subroutine which is called recursively.<br><br>\r
  21 \r
  22 kiriwrite_compile_clean_helper returns a value if a file in the directory being cleaned and has invalid permissions set.<br><br>\r
  23 \r
  24 <span class="heading">Parameters:</span><br><br>\r
  25 \r
  26 <div class="code">\r
  27     kiriwrite_compile_clean_helper(directory, keepdirectory, permissions);\r
  28 </div>\r
  29 \r
  30 <br>\r
  31 \r
  32 <span class="heading">Usage:</span><br><br>\r
  33 \r
  34 <div class="code">\r
  35     kiriwrite_compile_clean_helper(&quot;directory&quot;, 1);<br>\r
  36     $permissions = kiriwrite_compile_clean_helper(&quot;directory&quot;, 1);<br>\r
  37     kiriwrite_compile_clean_helper(&quot;directory&quot;, 1, 1);\r
  38 </div>\r
  39 \r
  40 <br>\r
  41 \r
  42 directory<br>\r
  43 Specifies the directory which should be cleaned.<br><br>\r
  44 \r
  45 keepdirectory<br>\r
  46 Keeps the parent directory.<br><br>\r
  47 \r
  48 <i>permissions</i><br>\r
  49 Checks if the permissions on all the files processed are valid before deleting and returns a value if they aren't.\r
  50                 </div>\r
  51         </body>\r
  52 </html>\r