DragonNest/Common/SVNLib/doc/group__cached__authentication__data.html
2024-12-19 09:48:26 +08:00

153 lines
7.7 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Subversion: Cached authentication data</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label>&nbsp;<u>S</u>earch&nbsp;for&nbsp;</label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul>
</div>
</div>
<div class="contents">
<h1>Cached authentication data</h1>Accessing cached authentication data in the user config area.
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structsvn__error__t.html">svn_error_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cached__authentication__data.html#gd5b78b4b2e6476a91f39358d5a003b8b">svn_config_read_auth_data</a> (apr_hash_t **hash, const char *cred_kind, const char *realmstring, const char *config_dir, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Use <em>cred_kind</em> and <em>realmstring</em> to locate a file within the ~/.subversion/auth/ area. <a href="#gd5b78b4b2e6476a91f39358d5a003b8b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structsvn__error__t.html">svn_error_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cached__authentication__data.html#g9383a4b14b70895fa72e0fef5d9f27af">svn_config_write_auth_data</a> (apr_hash_t *hash, const char *cred_kind, const char *realmstring, const char *config_dir, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Use <em>cred_kind</em> and <em>realmstring</em> to create or overwrite a file within the ~/.subversion/auth/ area. <a href="#g9383a4b14b70895fa72e0fef5d9f27af"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Accessing cached authentication data in the user config area.
<p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gd5b78b4b2e6476a91f39358d5a003b8b"></a><!-- doxytag: member="svn_config.h::svn_config_read_auth_data" ref="gd5b78b4b2e6476a91f39358d5a003b8b" args="(apr_hash_t **hash, const char *cred_kind, const char *realmstring, const char *config_dir, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsvn__error__t.html">svn_error_t</a>* svn_config_read_auth_data </td>
<td>(</td>
<td class="paramtype">apr_hash_t **&nbsp;</td>
<td class="paramname"> <em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>cred_kind</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>realmstring</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>config_dir</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_pool_t *&nbsp;</td>
<td class="paramname"> <em>pool</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Use <em>cred_kind</em> and <em>realmstring</em> to locate a file within the ~/.subversion/auth/ area.
<p>
If the file exists, initialize <em>*hash</em> and load the file contents into the hash, using <em>pool</em>. If the file doesn't exist, set <em>*hash</em> to NULL.<p>
If <em>config_dir</em> is not NULL it specifies a directory from which to read the config overriding all other sources.<p>
Besides containing the original credential fields, the hash will also contain <code>SVN_CONFIG_REALMSTRING_KEY</code>. The caller can examine this value as a sanity-check that the correct file was loaded.<p>
The hashtable will contain <code>const char *</code> keys and <code><a class="el" href="structsvn__string__t.html" title="A simple counted string.">svn_string_t</a> *</code> values.
</div>
</div><p>
<a class="anchor" name="g9383a4b14b70895fa72e0fef5d9f27af"></a><!-- doxytag: member="svn_config.h::svn_config_write_auth_data" ref="g9383a4b14b70895fa72e0fef5d9f27af" args="(apr_hash_t *hash, const char *cred_kind, const char *realmstring, const char *config_dir, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structsvn__error__t.html">svn_error_t</a>* svn_config_write_auth_data </td>
<td>(</td>
<td class="paramtype">apr_hash_t *&nbsp;</td>
<td class="paramname"> <em>hash</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>cred_kind</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>realmstring</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&nbsp;</td>
<td class="paramname"> <em>config_dir</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_pool_t *&nbsp;</td>
<td class="paramname"> <em>pool</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Use <em>cred_kind</em> and <em>realmstring</em> to create or overwrite a file within the ~/.subversion/auth/ area.
<p>
Write the contents of <em>hash</em> into the file. If <em>config_dir</em> is not NULL it specifies a directory to read the config overriding all other sources.<p>
Also, add <em>realmstring</em> to the file, with key <code>SVN_CONFIG_REALMSTRING_KEY</code>. This allows programs (or users) to verify exactly which set credentials live within the file.<p>
The hashtable must contain <code>const char *</code> keys and <code><a class="el" href="structsvn__string__t.html" title="A simple counted string.">svn_string_t</a> *</code> values.
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Oct 24 16:18:29 2008 for Subversion by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>