Source of: /manual/en/function.yp-err-string.php


<?php

include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';

$TOC = array();

$PARENTS = array();

include_once dirname(__FILE__) ."/toc/ref.nis.inc";

$setup = array (

  'home' => 

  array (

    0 => 'index.php',

    1 => 'PHP Manual',

  ),

  'head' => 

  array (

    0 => 'UTF-8',

    1 => 'en',

  ),

  'this' => 

  array (

    0 => 'function.yp-err-string.php',

    1 => 'yp_err_string',

  ),

  'up' => 

  array (

    0 => 'ref.nis.php',

    1 => 'YP/NIS Functions',

  ),

  'prev' => 

  array (

    0 => 'function.yp-cat.php',

    1 => 'yp_cat',

  ),

  'next' => 

  array (

    0 => 'function.yp-errno.php',

    1 => 'yp_errno',

  ),

);

$setup["toc"] = $TOC;

$setup["parents"] = $PARENTS;

manual_setup($setup);



manual_header();

?>

<div id="function.yp-err-string" class="refentry">

 <div class="refnamediv">

  <h1 class="refname">yp_err_string</h1>

  <p class="verinfo">(PHP 4 &gt;= 4.0.6, PHP 5 &lt;= 5.0.5)</p><p class="refpurpose"><span class="refname">yp_err_string</span> &mdash; <span class="dc-title">Returns the error string associated with the given error code</span></p>



 </div>

 

 <a name="function.yp-err-string.description"></a><div class="refsect1 description">

  <h3 class="title">Description</h3>

  <div class="methodsynopsis dc-description">

   <span class="type">string</span> <span class="methodname"><b>yp_err_string</b></span>

    ( <span class="methodparam"><span class="type">int</span> <tt class="parameter">$errorcode</tt></span>

   )</div>



  <p class="para rdfs-comment">

   Returns the error message associated with the given error code.

   Useful to indicate what exactly went wrong.

  </p>

 </div>





 <a name="function.yp-err-string.parameters"></a><div class="refsect1 parameters">

  <h3 class="title">Parameters</h3>

  <p class="para">

   </p><dl>



    <dt class="varlistentry">



     <span class="term"><i><tt class="parameter">errorcode</tt></i>

</span>



     </dt><dd class="listitem">



      <p class="para">

       The error code.

      </p>

     </dd>



    

   </dl>

<p>

  </p>

 </div>





 <a name="function.yp-err-string.returnvalues"></a><div class="refsect1 returnvalues">

  <h3 class="title">Return Values</h3>

  <p class="para">

   Returns the error message, as a string.

  </p>

 </div>





 <a name="function.yp-err-string.examples"></a><div class="refsect1 examples">

  <h3 class="title">Examples</h3>

  <p class="para">

   </p><div class="example">

    <p><b>Example #1 Example for NIS errors</b></p>

    <div class="example-contents programlisting">

<div class="phpcode"><code><span style="color: #000000">

<span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">echo&nbsp;</span><span style="color: #DD0000">"Error:&nbsp;"&nbsp;</span><span style="color: #007700">.&nbsp;</span><span style="color: #0000BB">yp_err_string</span><span style="color: #007700">(</span><span style="color: #0000BB">yp_errno</span><span style="color: #007700">());<br /></span><span style="color: #0000BB">?&gt;</span>

</span>

</code></div>

    </div>



   </div><p>

  </p>

 </div>





 <a name="function.yp-err-string.seealso"></a><div class="refsect1 seealso">

  <h3 class="title">See Also</h3>

  <p class="para">

   </p><ul class="simplelist">

    <li class="member"><a href="function.yp-errno.php" class="function" rel="rdfs-seeAlso">yp_errno()</a> - Returns the error code of the previous operation</li>

   </ul><p>

  </p>

 </div>



</div><?php manual_footer(); ?>
Our source is open

Source of: /manual/en/function.yp-err-string.php
