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 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 298918 $ -->
<refentry xml:id="function.oci-new-collection" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>oci_new_collection</refname>
<refpurpose>Allocates new collection object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>OCI-Collection</type><methodname>oci_new_collection</methodname>
<methodparam><type>resource</type><parameter>connection</parameter></methodparam>
<methodparam><type>string</type><parameter>tdo</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>schema</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Allocates a new collection object.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>connection</parameter></term>
<listitem>
<para>
An Oracle connection identifier, returned by
<function>oci_connect</function> or <function>oci_pconnect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>tdo</parameter></term>
<listitem>
<para>
Should be a valid named type (uppercase).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>schema</parameter></term>
<listitem>
<para>
Should point to the scheme, where the named type was created. The name
of the current user is the default value.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a new <classname>OCICollection</classname> object or &false; on
error.
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
In PHP versions before 5.0.0 you must use
<function>ocinewcollection</function> instead. This name still can be
used, it was left as alias of <function>oci_new_collection</function> for
downwards compatability. This, however, is deprecated and not recommended.
</para>
</note>
</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
-->
|