| Current File : //kunden/usr/share/doc/libopendmarc-devel/opendmarc_policy_status_to_str.html |
<html>
<head><title>opendmarc_policy_status_to_str()</title></head>
<body>
<!--
$Id: opendmarc_policy_status_to_str.html,v 1.5 2010/07/24 04:52:15 cm-msk Exp $
-->
<h1>opendmarc_policy_status_to_str()</h1>
<p align="right"><a href="index.html">[back to index]</a></p>
<table border="0" cellspacing=4 cellpadding=4>
<!---------- Synopsis ----------->
<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
<pre>
#include <dmarc.h>
const char * opendmarc_policy_status_to_str(
<a href="opendmarc_status_t.html"><tt>OPENDMARC_STATUS_T</tt></a> status
);
</pre>
Get a human readable string from a returned status value.
</td></tr>
<!----------- Description ---------->
<tr><th valign="top" align=left>DESCRIPTION</th><td>
<table border="1" cellspacing=1 cellpadding=4>
<tr align="left" valign=top>
<th width="80">Called When</th>
<td><tt>opendmarc_policy_status_to_str()</tt>
is called anytime
</tr>
</table>
<!----------- Arguments ---------->
<tr><th valign="top" align=left>ARGUMENTS</th><td>
<table border="1" cellspacing=0>
<tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
<tr valign="top"><td>status</td>
<td>Value of <a href="opendmarc_status_t.html"><tt>OPENDMARC_STATUS_T</tt></a> returned by
a call to a library fuction.
</td></tr>
</table>
</td></tr>
<!----------- Return Values ---------->
<tr>
<th valign="top" align=left>RETURN VALUES</th>
<td>
<ul>
<li><tt>const char *</tt> -- Success.
<li><tt>"Undefine Value"</tt> -- If the <tt>status</tt> is outside the known range of values.
</ul>
</td>
</tr>
<!----------- Notes ---------->
<tr>
<th valign="top" align=left>NOTES</th>
<td>
<ul>
<li>The return value is a string constant and should never be free()'d.
</ul>
</td>
</tr>
</table>
<hr size="1">
<font size="-1">
Copyright (c) 2012, The Trusted Domain Project. All rights reserved.
<br>
By using this file, you agree to the terms and conditions set
forth in the license.
</font>
</body>
</html>