Documentation/English (British)/developer-chapter1-kiriwritedatabaseedit.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.12: kiriwrite_database_edit</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.12 kiriwrite_database_edit</span><br><br>\r
  19 \r
  20 kiriwrite_database_edit edits information about a database. If the confirm value is not given then it will write a form for editing a database. If a database filename (old or new) is blank or the database name is blank when the database is edited then an error is returned.<br><br>\r
  21 \r
  22 kiriwrite_database_edit will return data that is intended for kiriwrite_output_page.<br><br>\r
  23 \r
  24 <span class="heading">Parameters:</span><br><br>\r
  25 \r
  26 <div class="code">\r
  27     kiriwrite_database_edit(filename, newfilename, newname, newdescription, newnotes, newcategories, confirm);\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     $pagedata = kiriwrite_database_edit(&quot;database&quot;);<br>\r
  36     $pagedata = kiriwrite_database_edit(&quot;database&quot;, &quot;newdatabase&quot;, &quot;New Database Name&quot;, &quot;New Database Description&quot;, &quot;New Notes&quot;, &quot;new, edited, database, categories&quot;, 1);\r
  37 </div>\r
  38 \r
  39 <br>\r
  40 \r
  41 filename<br>\r
  42 Specifies the filename of the database to edit. This is required each time the subroutine is called.<br><br>\r
  43 \r
  44 <i>newfilename</i><br>\r
  45 Specifies the new filename of the database. If the filename given is the same as the filename parameter then the filename does not change. This is required when the database is going to be edited.<br><br>\r
  46 \r
  47 <i>newdescription</i><br>\r
  48 Specifies the new description of the database. This is required when the database is going to be edited.<br><br>\r
  49 \r
  50 <i>newnotes</i><br>\r
  51 Specifies the new notes of the database. This is required when the database is going to be edited.<br><br>\r
  52 \r
  53 <i>newcategories</i><br>\r
  54 Specifies the new categories of the database. This is required when the database is going to be edited.<br><br>\r
  55 \r
  56 <i>confirm</i><br>\r
  57 Specifies if the action to edit a database should be confirmed by passing a '1'.<br><br>\r
  58                 </div>\r
  59         </body>\r
  60 </html>\r