Imported Upstream version 0.66.1
[hcoop/debian/courier-authlib.git] / auth_passwd.html
CommitLineData
d9898ee8 1<?xml version="1.0"?>
b0322a85 2<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/><title>auth_passwd</title><link rel="stylesheet" type="text/css" href="style.css"/><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"/><link rel="home" href="#auth-passwd" title="auth_passwd"/><link xmlns="" rel="stylesheet" type="text/css" href="manpage.css"/><meta xmlns="" name="MSSmartTagsPreventParsing" content="TRUE"/><link xmlns="" rel="icon" href="icon.gif" type="image/gif"/><!--
d9898ee8 3
b0322a85 4Copyright 1998 - 2009 Double Precision, Inc. See COPYING for distribution
d9898ee8 5information.
6
b0322a85 7--></head><body><div class="refentry"><a id="auth-passwd" shape="rect"> </a><div class="titlepage"/><div class="refnamediv"><h2>Name</h2><p>auth_passwd — Change account's password</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="literallayout"><p><br clear="none"/>
d9898ee8 8#include &lt;courierauth.h&gt;<br clear="none"/>
b0322a85 9</p></div><div class="funcsynopsis"><table border="0" class="funcprototype-table" summary="Function synopsis" style="cellspacing: 0; cellpadding: 0;"><tr><td rowspan="1" colspan="1"><code class="funcdef">int rc=<strong>auth_passwd</strong>(</code></td><td rowspan="1" colspan="1">const char *<var class="pdparam">service</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">const char *<var class="pdparam">username</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">const char *<var class="pdparam">oldpassword</var>, </td></tr><tr><td rowspan="1" colspan="1"> </td><td rowspan="1" colspan="1">const char *<var class="pdparam">newpassword</var><code>)</code>;</td></tr></table><div class="funcprototype-spacer"> </div></div></div><div class="refsect1"><a id="idm247878186144" shape="rect"> </a><h2>DESCRIPTION</h2><p>
d9898ee8 10If <em class="parameter"><code>username</code></em>'s password is
11<em class="parameter"><code>oldpassword</code></em>, it is replaced with
12<em class="parameter"><code>newpassword</code></em>.
13<em class="parameter"><code>service</code></em> identifies which so-called "service"'s
b0322a85 14password is changed; like <span class="quote">“<span class="quote">imap</span>”</span> or <span class="quote">“<span class="quote">pop3</span>”</span>.
d9898ee8 15Some Courier authentication library's back-end module can use different
16passwords for different services.
b0322a85 17<em class="parameter"><code>service</code></em> is ignored if this is not the case.</p></div><div class="refsect1"><a id="idm247881721808" shape="rect"> </a><h2>RETURNS</h2><p>
d9898ee8 18<code class="function">auth_passwd</code> returns 0 if the password was
19succesfully changed.
b0322a85 20A non-0 error code indicates a failure..</p></div><div class="refsect1"><a id="idm247881719808" shape="rect"> </a><h2>SEE ALSO</h2><p>
8d138742 21<a class="ulink" href="authlib.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">authlib</span>(3)</span></a>,
d9898ee8 22
8d138742 23<a class="ulink" href="auth_generic.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_generic</span>(3)</span></a>,
d9898ee8 24
8d138742 25<a class="ulink" href="auth_login.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_login</span>(3)</span></a>,
d9898ee8 26
8d138742 27<a class="ulink" href="auth_getuserinfo.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_getuserinfo</span>(3)</span></a>,
d9898ee8 28
8d138742 29<a class="ulink" href="auth_enumerate.html" target="_top" shape="rect"><span class="citerefentry"><span class="refentrytitle">auth_enumerate</span>(3)</span></a>.</p></div></div></body></html>