php-doc-en/reference/cubrid/functions/cubrid-put.xml
Esen Sagynov 0cc80e227c add cubrid documentation
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@301868 c90b9560-bf6c-de11-be94-00142212c4b1
2010-08-05 09:43:31 +00:00

111 lines
3.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.cubrid-put" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>cubrid_put</refname>
<refpurpose>Is used to update an attribute</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>cubrid_put</methodname>
<methodparam><type>int</type><parameter>conn_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>oid</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>attr</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
The <function>cubrid_put</function> function is used to update an attribute of the instance of the given <parameter>oid</parameter>. You can update single attribute by using string data type to set <parameter>attr</parameter>. In such case, you can use integer, float-point, or string type data for the <parameter>value</parameter> argument. To update multiple number of attributes, you can disregard the <parameter>attr</parameter> argument, and set <parameter>value</parameter> argument with associative array data type. However, you cannot use the method for attribute of collection type. You have to use APIs related to collection type (<function>cubrid_set_add</function>, <function>cubrid_set_drop</function>, etc) when you want to use <function>cubrid_put</function> on collection typed attribute.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>conn_handle</parameter></term>
<listitem><para>Connection handle.</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>oid</parameter></term>
<listitem><para>Oid of the instance that you want to update.</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>attr</parameter></term>
<listitem><para>Name of the attribute that you want to update.</para></listitem>
</varlistentry>
<varlistentry>
<term><parameter>value</parameter></term>
<listitem><para>New value that you want to assign to the attribute.</para></listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&true;, when process is successful.
</para>
<para>
&false;, when process is unsuccessful.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>cubrid_put</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$attrarray = cubrid_get ($con, $oid);
$attrarray["name"] = "New Name";
cubrid_put ($con, $oid, $attrarray);
cubrid_put ($con, $oid, "name", "New Name2");
cubrid_put ($con, $oid, "hobbies", array("aa", "bb"));
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>cubrid_get</function></member>
<member><function>cubrid_set_add</function></member>
<member><function>cubrid_set_drop</function></member>
<member><function>cubrid_seq_insert</function></member>
<member><function>cubrid_seq_drop</function></member>
<member><function>cubrid_seq_put</function></member>
</simplelist>
</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:"~/.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
-->