cubrid-col-get.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->

<refentry xml:id="function.cubrid-col-get" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>cubrid_col_get</refname>
  <refpurpose>Get contents of collection type column using OID</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>array</type><methodname>cubrid_col_get</methodname>
   <methodparam><type>resource</type><parameter>conn_identifier</parameter></methodparam>
   <methodparam><type>string</type><parameter>oid</parameter></methodparam>
   <methodparam><type>string</type><parameter>attr_name</parameter></methodparam>
  </methodsynopsis>
  <para>
    The <function>cubrid_col_get</function> function is used to get contents
    of the elements of the collection type (set, multiset, sequence) attribute
    you requested as an array.
  </para>
 </refsect1>
 
  <refsect1 role="parameters">
 &reftitle.parameters;
 <para>
  <variablelist>
    <varlistentry>
  <term><parameter>conn_identifier</parameter></term>
  <listitem><para>Connection identifier.</para></listitem>
   </varlistentry>
   <varlistentry>
  <term><parameter>oid</parameter></term>
  <listitem><para>OID of the instance that you want to read.</para></listitem>
  </varlistentry>
   <varlistentry>
  <term><parameter>attr_name</parameter></term>
  <listitem><para>Attribute name that you want to read from the instance.</para></listitem>
  </varlistentry>
  </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
    Array (0-based numerical array) containing the elements you requested,
    when process is successful;
  </para>
    <para>
    &false; (to distinguish the error from the situation of attribute having
    empty collection or NULL, in case of error, a warning message is shown; in
    such case you can check the error by using
    <function>cubrid_error_code</function>), when process is unsuccessful.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title><function>cubrid_col_get</function> example</title>
   <programlisting role="php">
<![CDATA[
<?php
$conn = cubrid_connect("localhost", 33000, "demodb", "dba");

@cubrid_execute($conn, "DROP TABLE foo");
cubrid_execute($conn, "CREATE TABLE foo(a int AUTO_INCREMENT, b set(int), c list(int), d char(10))");
cubrid_execute($conn, "INSERT INTO foo(a, b, c, d) VALUES(1, {1,2,3}, {11,22,33,333}, 'a')");

$req = cubrid_execute($conn, "SELECT * FROM foo", CUBRID_INCLUDE_OID);

cubrid_move_cursor($req, 1, CUBRID_CURSOR_FIRST);
$oid = cubrid_current_oid($req);

$attr = cubrid_col_get($conn, $oid, "b");
var_dump($attr);

$size = cubrid_col_size($conn, $oid, "b");
var_dump($size);

cubrid_close_request($req);
cubrid_disconnect($conn);
?>
]]>
   </programlisting>
    &example.outputs;
    <screen>
<![CDATA[
array(3) {
  [0]=>
  string(1) "1"
  [1]=>
  string(1) "2"
  [2]=>
  string(1) "3"
}
int(3)
]]>
   </screen>
  </example>
 </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
-->