Sophie

Sophie

distrib > Mageia > 4 > x86_64 > by-pkgid > f800694edefe91adea2624f711a41a2d > files > 42

php-manual-en-5.5.7-1.mga4.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
 <head>
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
  <title>Set the login.</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="amqpconnection.sethost.html">AMQPConnection::setHost</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="amqpconnection.setpassword.html">AMQPConnection::setPassword</a></div>
 <div class="up"><a href="class.amqpconnection.html">AMQPConnection</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="amqpconnection.setlogin" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">AMQPConnection::setLogin</h1>
  <p class="verinfo">(PECL amqp &gt;= Unknown)</p><p class="refpurpose"><span class="refname">AMQPConnection::setLogin</span> &mdash; <span class="dc-title">Set the login.</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-amqpconnection.setlogin-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>AMQPConnection::setLogin</strong></span>
    ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$login</code></span>
   )</div>

  <p class="para rdfs-comment">
   This method will set the login string used to connect to the AMQP broker.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-amqpconnection.setlogin-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>

    <dt>

     <span class="term"><em><code class="parameter">login</code></em></span>
     <dd>

      <p class="para">
       The login string used to authenticate with the AMQP broker.
      </p>
     </dd>

    </dt>

   </dl>

  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-amqpconnection.setlogin-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-amqpconnection.setlogin-errors">
  <h3 class="title">Errors/Exceptions</h3>
  <p class="para">
   Throws an <strong class="classname">AMQPConnectionException</strong> if
   <em><code class="parameter">login</code></em> is longer then 32characters.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-amqpconnection.setlogin-examples">
  <h3 class="title">Examples</h3>
  <p class="para">
   <div class="example" id="example-4192">
    <p><strong>Example #1  <span class="methodname"><strong>AMQPConnection::setLogin()</strong></span> example</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">/*&nbsp;Create&nbsp;a&nbsp;new&nbsp;connection&nbsp;*/<br /></span><span style="color: #0000BB">$cnn&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</span><span style="color: #0000BB">AMQPConnection</span><span style="color: #007700">();<br /><br /></span><span style="color: #FF8000">//&nbsp;set&nbsp;the&nbsp;login<br /></span><span style="color: #0000BB">$cnn</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">setLogin</span><span style="color: #007700">(</span><span style="color: #DD0000">'myusername'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
    </div>

   </div>
  </p>
 </div>



</div><hr /><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="amqpconnection.sethost.html">AMQPConnection::setHost</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="amqpconnection.setpassword.html">AMQPConnection::setPassword</a></div>
 <div class="up"><a href="class.amqpconnection.html">AMQPConnection</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>