File: dbplus-rcrtlike.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (52 lines) | stat: -rw-r--r-- 1,799 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/dbplus.xml, last change in rev 1.1 -->
  <refentry id="function.dbplus-rcrtlike">
   <refnamediv>
    <refname>dbplus_rcrtlike</refname>
    <refpurpose>Creates an empty copy of a relation with default indices</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
    <methodsynopsis>
     <type>mixed</type><methodname>dbplus_rcrtlike</methodname>
     <methodparam><type>string</type><parameter>name</parameter></methodparam>
     <methodparam><type>resource</type><parameter>relation</parameter></methodparam>
     <methodparam choice="opt"><type>int</type><parameter>overwrite</parameter></methodparam>
    </methodsynopsis>
    &warn.experimental.func;
    <para>
     <function>dbplus_rcrtexact</function> will create an  empty copy
     of the given <parameter>relation</parameter> under a new
     <parameter>name</parameter>, but with default indices. An
     existing relation by the same <parameter>name</parameter> will
     only be overwritten if <parameter>overwrite</parameter> is &true;
     and no other process is currently using the relation.
    </para>
    <para>
     Returns resource on success or <constant>DBPLUS_ERR_UNKNOWN</constant> on
     failure.
    </para>
   </refsect1>
  </refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->