php-doc-en/reference/sybase/functions/sybase-set-message-handler.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
  <refentry id="function.sybase-set-message-handler">
   <refnamediv>
    <refname>sybase_set_message_handler</refname>
    <refpurpose>Sets the handler called when a server message is raised</refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>sybase_set_message_handler</methodname>
      <methodparam><type>callback</type><parameter>handler</parameter></methodparam>
     </methodsynopsis>
    <para> 
     <function>sybase_set_message_handler</function> sets a user function to
     handle messages generated by the server. You may specify the name of a
     global function, or use an array to specify an object reference and a
     method name. 
    </para>
    <para>
     The handler expects five arguments in the following order: message
     number, severity, state, line number and description.  The first four are
     integers.  The last is a string.  If the function returns &false;, PHP
     generates an ordinary error message.
    </para>
    <para>
     &return.success;
    </para>
    <para>
     <example>
      <title><function>sybase_set_message_handler</function> callback function</title>
      <programlisting role="php">
<![CDATA[
<?php
    function msg_handler($msgnumber, $severity, $state, $line, $text) {
        var_dump($msgnumber, $severity, $state, $line, $text);
    }
    
    sybase_set_message_handler('msg_handler');
?>
]]>
      </programlisting>
     </example>
     <example>
      <title><function>sybase_set_message_handler</function> callback to a class</title>
      <programlisting role="php">
<![CDATA[
<?php
    class Sybase {
        function handler($msgnumber, $severity, $state, $line, $text) {
            var_dump($msgnumber, $severity, $state, $line, $text);
        }
    }
    
    $sybase= new Sybase();
    sybase_set_message_handler(array($sybase, 'handler'));
?>
]]>
      </programlisting>
     </example>
     <example>
      <title><function>sybase_set_message_handler</function> unhandled messages</title>
      <programlisting role="php">
<![CDATA[
<?php
    // Return FALSE from this function to indicate you can't handle
    // this. The error is printed out as a warning, the way you're used
    // to it if there is no handler installed.
    function msg_handler($msgnumber, $severity, $state, $line, $text) {
        if (257 == $msgnumber) {
            return false;
        }
        var_dump($msgnumber, $severity, $state, $line, $text);
    }
    
    sybase_set_message_handler('msg_handler');
?>
]]>
      </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
-->