irchtml Sat Mar 6 03:54:48 2004 EDT
Modified files:
/phpdoc/en/reference/sem/functions shm-put-var.xml
Log:
Fixed proto, added return values, note about warnings
(bug #27510)
http://cvs.php.net/diff.php/phpdoc/en/reference/sem/functions/shm-put-var.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/sem/functions/shm-put-var.xml
diff -u phpdoc/en/reference/sem/functions/shm-put-var.xml:1.2
phpdoc/en/reference/sem/functions/shm-put-var.xml:1.3
--- phpdoc/en/reference/sem/functions/shm-put-var.xml:1.2 Wed Apr 17 02:43:52
2002
+++ phpdoc/en/reference/sem/functions/shm-put-var.xml Sat Mar 6 03:54:46 2004
@@ -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.
