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

143 lines
10 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: svn_auth_provider_t Struct Reference</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 class="current"><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 class="tabs">
<ul>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>svn_auth_provider_t Struct Reference<br>
<small>
[<a class="el" href="group__auth__fns.html">Authentication functions</a>]</small>
</h1><!-- doxytag: class="svn_auth_provider_t" -->The main authentication "provider" vtable.
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="svn__auth_8h-source.html">svn_auth.h</a>&gt;</code>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsvn__auth__provider__t.html#0d358c058410dfc169d2efa3cd76f477">cred_kind</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The kind of credentials this provider knows how to retrieve. <a href="#0d358c058410dfc169d2efa3cd76f477"></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="structsvn__auth__provider__t.html#efc235bc5c2c34b61844dda560591b81">first_credentials</a> )(void **credentials, void **iter_baton, void *provider_baton, apr_hash_t *parameters, const char *realmstring, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get an initial set of credentials. <a href="#efc235bc5c2c34b61844dda560591b81"></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="structsvn__auth__provider__t.html#3f5b83e86f2dfa5817bf60c95ee353db">next_credentials</a> )(void **credentials, void *iter_baton, void *provider_baton, apr_hash_t *parameters, const char *realmstring, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a different set of credentials. <a href="#3f5b83e86f2dfa5817bf60c95ee353db"></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="structsvn__auth__provider__t.html#616c66066c665df9e1b6505b456106dc">save_credentials</a> )(<a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> *saved, void *credentials, void *provider_baton, apr_hash_t *parameters, const char *realmstring, apr_pool_t *pool)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Save credentials. <a href="#616c66066c665df9e1b6505b456106dc"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The main authentication "provider" vtable.
<p>
<p>Definition at line <a class="el" href="svn__auth_8h-source.html#l00085">85</a> of file <a class="el" href="svn__auth_8h-source.html">svn_auth.h</a>.</p>
<hr><h2>Field Documentation</h2>
<a class="anchor" name="0d358c058410dfc169d2efa3cd76f477"></a><!-- doxytag: member="svn_auth_provider_t::cred_kind" ref="0d358c058410dfc169d2efa3cd76f477" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="structsvn__auth__provider__t.html#0d358c058410dfc169d2efa3cd76f477">svn_auth_provider_t::cred_kind</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
The kind of credentials this provider knows how to retrieve.
<p>
<p>Definition at line <a class="el" href="svn__auth_8h-source.html#l00088">88</a> of file <a class="el" href="svn__auth_8h-source.html">svn_auth.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="efc235bc5c2c34b61844dda560591b81"></a><!-- doxytag: member="svn_auth_provider_t::first_credentials" ref="efc235bc5c2c34b61844dda560591b81" args=")(void **credentials, void **iter_baton, void *provider_baton, apr_hash_t *parameters, const char *realmstring, 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>*(* <a class="el" href="structsvn__auth__provider__t.html#efc235bc5c2c34b61844dda560591b81">svn_auth_provider_t::first_credentials</a>)(void **credentials, void **iter_baton, void *provider_baton, apr_hash_t *parameters, const char *realmstring, apr_pool_t *pool) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get an initial set of credentials.
<p>
Set <em>*credentials</em> to a set of valid credentials within <em>realmstring</em>, or NULL if no credentials are available. Set <em>*iter_baton</em> to context that allows a subsequent call to <code>next_credentials</code>, in case the first credentials fail to authenticate. <em>provider_baton</em> is general context for the vtable, <em>parameters</em> contains any run-time data that the provider may need, and <em>realmstring</em> comes from the <a class="el" href="group__auth__fns.html#ge830b04d8a93c8b60f802d6809425665" title="Get an initial set of credentials.">svn_auth_first_credentials()</a> call.
</div>
</div><p>
<a class="anchor" name="3f5b83e86f2dfa5817bf60c95ee353db"></a><!-- doxytag: member="svn_auth_provider_t::next_credentials" ref="3f5b83e86f2dfa5817bf60c95ee353db" args=")(void **credentials, void *iter_baton, void *provider_baton, apr_hash_t *parameters, const char *realmstring, 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>*(* <a class="el" href="structsvn__auth__provider__t.html#3f5b83e86f2dfa5817bf60c95ee353db">svn_auth_provider_t::next_credentials</a>)(void **credentials, void *iter_baton, void *provider_baton, apr_hash_t *parameters, const char *realmstring, apr_pool_t *pool) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a different set of credentials.
<p>
Set <em>*credentials</em> to another set of valid credentials (using <em>iter_baton</em> as the context from previous call to first_credentials or next_credentials). If no more credentials are available, set <em>*credentials</em> to NULL. If the provider only has one set of credentials, this function pointer should simply be NULL. <em>provider_baton</em> is general context for the vtable, <em>parameters</em> contains any run-time data that the provider may need, and <em>realmstring</em> comes from the <a class="el" href="group__auth__fns.html#ge830b04d8a93c8b60f802d6809425665" title="Get an initial set of credentials.">svn_auth_first_credentials()</a> call.
</div>
</div><p>
<a class="anchor" name="616c66066c665df9e1b6505b456106dc"></a><!-- doxytag: member="svn_auth_provider_t::save_credentials" ref="616c66066c665df9e1b6505b456106dc" args=")(svn_boolean_t *saved, void *credentials, void *provider_baton, apr_hash_t *parameters, const char *realmstring, 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>*(* <a class="el" href="structsvn__auth__provider__t.html#616c66066c665df9e1b6505b456106dc">svn_auth_provider_t::save_credentials</a>)(<a class="el" href="svn__types_8h.html#22b35baddc4213c688d1bb12feea1024">svn_boolean_t</a> *saved, void *credentials, void *provider_baton, apr_hash_t *parameters, const char *realmstring, apr_pool_t *pool) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Save credentials.
<p>
Store <em>credentials</em> for future use. <em>provider_baton</em> is general context for the vtable, and <em>parameters</em> contains any run-time data the provider may need. Set <em>*saved</em> to TRUE if the save happened, or FALSE if not. The provider is not required to save; if it refuses or is unable to save for non-fatal reasons, return FALSE. If the provider never saves data, then this function pointer should simply be NULL. <em>realmstring</em> comes from the <a class="el" href="group__auth__fns.html#ge830b04d8a93c8b60f802d6809425665" title="Get an initial set of credentials.">svn_auth_first_credentials()</a> call.
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="svn__auth_8h-source.html">svn_auth.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Oct 24 16:18:30 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>