Source of: /manual/en/function.svn-auth-get-parameter.php


<?php

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

$TOC = array();

$PARENTS = array();

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

$setup = array (

  'home' => 

  array (

    0 => 'index.php',

    1 => 'PHP Manual',

  ),

  'head' => 

  array (

    0 => 'UTF-8',

    1 => 'en',

  ),

  'this' => 

  array (

    0 => 'function.svn-auth-get-parameter.php',

    1 => 'svn_auth_get_parameter',

  ),

  'up' => 

  array (

    0 => 'ref.svn.php',

    1 => 'SVN Functions',

  ),

  'prev' => 

  array (

    0 => 'function.svn-add.php',

    1 => 'svn_add',

  ),

  'next' => 

  array (

    0 => 'function.svn-auth-set-parameter.php',

    1 => 'svn_auth_set_parameter',

  ),

);

$setup["toc"] = $TOC;

$setup["parents"] = $PARENTS;

manual_setup($setup);



manual_header();

?>

<div id="function.svn-auth-get-parameter" class="refentry">

 <div class="refnamediv">

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

  <p class="verinfo">(PECL svn &gt;= 0.1.0)</p><p class="refpurpose"><span class="refname">svn_auth_get_parameter</span> &mdash; <span class="dc-title">Retrieves authentication parameter</span></p>



 </div>



 <a name="function.svn-auth-get-parameter.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>svn_auth_get_parameter</b></span>

    ( <span class="methodparam"><span class="type">string</span> <tt class="parameter">$key</tt></span>

   )</div>



  <p class="para rdfs-comment">

   Retrieves authentication parameter at <i><tt class="parameter">key</tt></i>

.

   For a list of valid keys and their meanings, consult the

   <a href="svn.constants.php#svn.constants.auth" class="link">authentication constants list</a>.

  </p>

 </div>





 <a name="function.svn-auth-get-parameter.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">key</tt></i>

</span>



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



      <p class="para">

       String key name. Use the <a href="svn.constants.php#svn.constants.auth" class="link">authentication constants</a>

       defined by this extension to specify a key.

      </p>

     </dd>



    

   </dl>

<p>

  </p>



 </div>



 <a name="function.svn-auth-get-parameter.returnvalues"></a><div class="refsect1 returnvalues">

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

  <p class="para">

   Returns the string value of the parameter at <i><tt class="parameter">key</tt></i>

;

   returns <b><tt class="constant">NULL</tt></b> if parameter does not exist.

  </p>

 </div>





 <a name="function.svn-auth-get-parameter.notes"></a><div class="refsect1 notes">

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

  <div class="warning"><b class="warning">Warning</b><p class="simpara">This function is

<em class="emphasis">EXPERIMENTAL</em>. The behaviour of this function, its name, and

surrounding documentation may change without notice in a future release of PHP.

This function should be used at your own risk.

</p></div>

 </div>





 



 



 



 <a name="function.svn-auth-get-parameter.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.svn-auth-set-parameter.php" class="function" rel="rdfs-seeAlso">svn_auth_set_parameter()</a> - Sets an authentication parameter</li>

    <li class="member"><a href="svn.constants.php#svn.constants.auth" class="link">Authentication constants</a></li>

   </ul><p>

  </p>

 </div>





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

Source of: /manual/en/function.svn-auth-get-parameter.php
