Documentation/English (British)/developer-chapter3-connecttemplate.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.19: connecttemplate</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.19 connecttemplate</span><br><br>\r
  19 \r
  20 Connects to the template 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->connecttemplate(missingignore);\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->connecttemplate(1);\r
  34 </div>\r
  35 \r
  36 <br>\r
  37 \r
  38 missingignore<br>\r
  39 Specifies that an error should not be returned if the template database does not exist.<br><br>\r
  40 \r
  41 If the template database does not exist then the error returned should be 'TemplateDatabaseDoesNotExist' in the $error scalar.<br><br>\r
  42 \r
  43 If (when using a file-based database module) the template database has invalid permissions set then the error returned should be 'TemplateDatabaseInvalidPermissionsSet' in the $error scalar.<br><br>\r
  44 \r
  45 If a database error occurs while connecting to the template database, the error returned should be 'TemplateDatabaseError' in the $error scalar and the information about the error should be placed in the $errorext scalar.\r
  46                 </div>\r
  47         </body>\r
  48 </html>\r