shm-put-var.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.shm-put-var">
 <refnamediv>
  <refname>shm_put_var</refname>
  <refpurpose>Inserts or updates a variable in shared memory</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>shm_put_var</methodname>
   <methodparam><type>resource</type><parameter>shm_identifier</parameter></methodparam>
   <methodparam><type>int</type><parameter>variable_key</parameter></methodparam>
   <methodparam><type>mixed</type><parameter>variable</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>shm_put_var</function> inserts or updates the
   <parameter>variable</parameter> with the given
   <parameter>variable_key</parameter>.
  </para>
  <para>
   Warnings (<constant>E_WARNING</constant> level) will be issued if
   <parameter>shm_identifier</parameter> is not a valid SysV shared memory
   index or if there was not enough shared memory remaining to complete your
   request.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>shm_identifier</parameter></term>
     <listitem>
      <para>
       A shared memory resource handle as returned by
       <function>shm_attach</function>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>variable_key</parameter></term>
     <listitem>
      <para>
       The variable key.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>variable</parameter></term>
     <listitem>
      <para>
       The variable. All <link linkend="language.types">variable types</link>
       that <function>serialize</function> supports may be used: generally
       this means all types except for resources and some internal objects
       that cannot be serialized.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>shm_get_var</function></member>
    <member><function>shm_has_var</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
-->