Add getResultMessage() docs.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@283672 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Andrei Zmievski 2009-07-07 19:07:07 +00:00
parent 887db47107
commit ea6162a941
2 changed files with 84 additions and 1 deletions

View file

@ -0,0 +1,82 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="memcached.getresultmessage" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Memcached::getResultMessage</refname>
<refpurpose>Return the message describing the result of the last operation</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>Memcached::getResultMessage</methodname>
<void />
</methodsynopsis>
<para>
<function>Memcached::getResultMessage</function> returns a string that
describes the result code of the last executed Memcached method.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Message describing the result of the last Memcached operation.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>Memcached::getResultMessage</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$m = new Memcached();
$m->addServer('localhost', 11211);
$m->add('foo', 'bar'); // first time should succeed
$m->add('foo', 'bar');
echo $m->getResultMessage(),"\n";
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
NOT STORED
]]>
</screen>
</example>
</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:"../../../../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
-->

View file

@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8'?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!--
Do NOT translate this file
-->
@ -27,6 +27,7 @@
<function name='memcached::getMultiByKey' from='PECL memcached &gt;= 0.1.0'/>
<function name='memcached::getOption' from='PECL memcached &gt;= 0.1.0'/>
<function name='memcached::getResultCode' from='PECL memcached &gt;= 0.1.0'/>
<function name='memcached::getResultMessage' from='PECL memcached &gt;= 1.0.0'/>
<function name='memcached::getServerByKey' from='PECL memcached &gt;= 0.1.0'/>
<function name='memcached::getServerList' from='PECL memcached &gt;= 0.1.0'/>
<function name='memcached::getStats' from='PECL memcached &gt;= 0.1.0'/>