php-doc-en/reference/dbplus/functions/dbplus-rcrtlike.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

91 lines
2.4 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.dbplus-rcrtlike" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>dbplus_rcrtlike</refname>
<refpurpose>Creates an empty copy of a relation with default indices</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<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>
<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.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
<para>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>relation</parameter></term>
<listitem>
<para>
The copied relation, opened by <function>dbplus_open</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>overwrite</parameter></term>
<listitem>
<para>
An existing relation by the same <parameter>name</parameter> will only
be overwritten if this parameter is set to &true; and no other process
is currently using the relation.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns resource on success or <constant>DBPLUS_ERR_UNKNOWN</constant> on
failure.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&warn.experimental.func;
</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:"~/.phpdoc/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
-->