php-doc-en/reference/mqseries/functions/mqseries-strerror.xml
Philippe Tjon - A - Hen 045b5b22c3 Initial release of documentation
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@250916 c90b9560-bf6c-de11-be94-00142212c4b1
2008-01-19 20:29:01 +00:00

94 lines
2.2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.mqseries-strerror" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>mqseries_strerror</refname>
<refpurpose>Returns the error message corresponding to a result code (MQRC).</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type>
<methodname>mqseries_strerror</methodname>
<methodparam>
<type>int</type>
<parameter>reason</parameter>
</methodparam>
</methodsynopsis>
<para>
<function>mqseries_strerror</function>
returns the message that correspond to the reason result code.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>reason</parameter>
</term>
<listitem>
<para>Reason code qualifying the compCode.</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>string representation of the reason code message.</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>
<function>mqseries_strerror</function>
example
</title>
<programlisting role="php">
<![CDATA[
<?php
if ($comp_code !== MQSERIES_MQCC_OK) {
printf("open CompCode:%d Reason:%d Text:%s<br>\n", $comp_code, $reason, mqseries_strerror($reason));
exit;
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Connx CompCode:2 Reason:2059 Text:Queue manager not available for connection.
]]>
</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
-->