php-doc-en/reference/sam/functions/SAM-Connection-error.xml
Dave Renshaw 8c6a1afe66 *** empty log message ***
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@224645 c90b9560-bf6c-de11-be94-00142212c4b1
2006-12-08 17:21:40 +00:00

75 lines
2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.SAM-Connection-error">
<refnamediv>
<refname>SAMConnection->error</refname>
<refpurpose>Contains the text description of the last failed SAM operation.</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<classsynopsis>
<ooclass><classname>SAMConnection</classname></ooclass>
<fieldsynopsis><type>string</type><varname>error</varname></fieldsynopsis>
</classsynopsis>
<para>
<function>error</function> Contains the text description of the last failed SAM operation on this connection. If the last operation completed successfully this property contains an empty string.
</para>
</refsect1>
<refsect1>
&reftitle.returnvalues;
<para>
A string containing the text description of the last error type encountered on the connection. An empty string indicates that the last operation on this connection completed successfully.
</para>
</refsect1>
<refsect1>
&reftitle.seealso;
<para>
<function>SAMConnection->errno</function>
</para>
</refsect1>
<refsect1>
&reftitle.examples;
<para>
<example>
<title>Using the error number and description properties</title>
<programlisting role="php">
<![CDATA[
<?php
$conn = new SAMConnection();
$conn->connect(SAM_WMQ, array(SAM_HOST => 'localhost', SAM_PORT => 1506));
$msg = new SAMMessage('This is a simple text item');
if (!$conn->send('topic://test', $msg)) {
// The Send failed!
echo "Send failed ($conn->errno) $conn->error";
}
?>
]]>
</programlisting>
</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
-->