<!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>Sets an authentication parameter</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.svn-auth-get-parameter.html">svn_auth_get_parameter</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.svn-blame.html">svn_blame</a></div>
<div class="up"><a href="ref.svn.html">SVN Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><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 >= 0.1.0)</p><p class="refpurpose"><span class="refname">svn_auth_set_parameter</span> — <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="type"><span class="type void">void</span></span> <span class="methodname"><strong>svn_auth_set_parameter</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$key</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
)</div>
<p class="para rdfs-comment">
Sets authentication parameter at <em><code class="parameter">key</code></em> to <em><code class="parameter">value</code></em>.
For a list of valid keys and their meanings, consult the
<a href="svn.constants.html#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>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">key</code></em></span>
<dd>
<p class="para">
String key name. Use the <a href="svn.constants.html#svn.constants.auth" class="link">authentication constants</a>
defined by this extension to specify a key.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">value</code></em></span>
<dd>
<p class="para">
String value to set to parameter at key. Format of value varies
with the parameter.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.svn-auth-set-parameter-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</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 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>
<div class="refsect1 examples" id="refsect1-function.svn-auth-set-parameter-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4657">
<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 'Bob' and the default password is 'abc123':
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?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">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.svn-auth-set-parameter-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.svn-auth-get-parameter.html" class="function" rel="rdfs-seeAlso">svn_auth_get_parameter()</a> - Retrieves authentication parameter</span></li>
<li class="member"><a href="svn.constants.html#svn.constants.auth" class="link">Authentication constants</a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.svn-auth-get-parameter.html">svn_auth_get_parameter</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.svn-blame.html">svn_blame</a></div>
<div class="up"><a href="ref.svn.html">SVN Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
