Fixed proto, added return values, note about warnings

(bug #27510)


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@153009 c90b9560-bf6c-de11-be94-00142212c4b1

reference/sem/functions/shm-put-var.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
 <!-- splitted from ./en/functions/sem.xml, last change in rev 1.2 -->
   <refentry id="function.shm-put-var">
    <refnamediv>
@@ -10,7 +10,7 @@
    <refsect1>
     <title>Description</title>
      <methodsynopsis>
-      <type>int</type><methodname>shm_put_var</methodname>
+      <type>bool</type><methodname>shm_put_var</methodname>
       <methodparam><type>int</type><parameter>shm_identifier</parameter></methodparam>
       <methodparam><type>int</type><parameter>variable_key</parameter></methodparam>
       <methodparam><type>mixed</type><parameter>variable</parameter></methodparam>
@@ -19,7 +19,16 @@
      Inserts or updates a <parameter>variable</parameter> with a given
      <parameter>variable_key</parameter>. <link
      linkend="language.types">All variable-types</link> are supported.
-    </para> 
+    </para>
+    <para>
+    &return.success;
+    </para>
+    <para>
+     Warnings (<literal>E_WARNING</literal> 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>
     <note>
      <simpara>
       This function does not work on Windows systems.