<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = 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-set-parameter.php',
    1 => 'svn_auth_set_parameter',
    2 => 'Sets an authentication parameter',
  ),
  'up' => 
  array (
    0 => 'ref.svn.php',
    1 => 'SVN Functions',
  ),
  'prev' => 
  array (
    0 => 'function.svn-auth-get-parameter.php',
    1 => 'svn_auth_get_parameter',
  ),
  'next' => 
  array (
    0 => 'function.svn-blame.php',
    1 => 'svn_blame',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/svn/functions/svn-auth-set-parameter.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.svn-auth-set-parameter" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">svn_auth_set_parameter</h1>
  <p class="verinfo">(PECL svn &gt;= 0.1.0)</p><p class="refpurpose"><span class="refname">svn_auth_set_parameter</span> &mdash; <span class="dc-title">Sets an authentication parameter</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.svn-auth-set-parameter-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>svn_auth_set_parameter</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$key</code></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$value</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>

  <p class="simpara">
   Sets authentication parameter at <code class="parameter">key</code> to <code class="parameter">value</code>.
   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>


 <div class="refsect1 parameters" id="refsect1-function.svn-auth-set-parameter-parameters">
  <h3 class="title">Parameters</h3>
  <dl>
   
    <dt><code class="parameter">key</code></dt>
    <dd>
     <span class="simpara">
      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.
     </span>
    </dd>
   
   
    <dt><code class="parameter">value</code></dt>
    <dd>
     <span class="simpara">
      String value to set to parameter at key. Format of value varies
      with the parameter.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.svn-auth-set-parameter-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="simpara">
   No value is returned.
  </p>
 </div>


 

 

 <div class="refsect1 examples" id="refsect1-function.svn-auth-set-parameter-examples">
  <h3 class="title">Examples</h3>
  <div class="example" id="example-1">
   <p><strong>Example #1 Default authentication example</strong></p>
   <div class="example-contents"><p>
    This example configures SVN so that the default username to use
    is &#039;Bob&#039; and the default password is &#039;abc123&#039;:
   </p></div>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />svn_auth_set_parameter</span><span style="color: #007700">(</span><span style="color: #0000BB">SVN_AUTH_PARAM_DEFAULT_USERNAME</span><span style="color: #007700">, </span><span style="color: #DD0000">'Bob'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">svn_auth_set_parameter</span><span style="color: #007700">(</span><span style="color: #0000BB">SVN_AUTH_PARAM_DEFAULT_PASSWORD</span><span style="color: #007700">, </span><span style="color: #DD0000">'abc123'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 notes" id="refsect1-function.svn-auth-set-parameter-notes">
  <h3 class="title">Notes</h3>
  <div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
<em>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>


 <div class="refsect1 seealso" id="refsect1-function.svn-auth-set-parameter-seealso">
  <h3 class="title">See Also</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.svn-auth-get-parameter.php" class="function" rel="rdfs-seeAlso">svn_auth_get_parameter()</a> - Retrieves authentication parameter</span></li>
   <li><a href="svn.constants.php#svn.constants.auth" class="link">Authentication constants</a></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>