~ubuntu-branches/ubuntu/quantal/opendmarc/quantal-backports

« back to all changes in this revision

Viewing changes to libopendmarc/docs/opendmarc_policy_fetch_rf.html

  • Committer: Package Import Robot
  • Author(s): Scott Kitterman
  • Date: 2013-04-01 23:20:45 UTC
  • mfrom: (4.1.3 sid)
  • Revision ID: package-import@ubuntu.com-20130401232045-r994v0oz6b2ha6ef
Tags: 1.1.2-1~ubuntu12.10.1
No-change backport to quantal

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<html>
 
2
<head><title>opendmarc_policy_fetch_rf()</title></head>
 
3
<body>
 
4
<!--
 
5
$Id: opendmarc_policy_fetch_rf.html,v 1.5 2010/07/24 04:52:15 cm-msk Exp $
 
6
-->
 
7
<h1>opendmarc_policy_fetch_rf()</h1>
 
8
<p align="right"><a href="index.html">[back to index]</a></p>
 
9
 
 
10
<table border="0" cellspacing=4 cellpadding=4>
 
11
<!---------- Synopsis ----------->
 
12
<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
 
13
<pre>
 
14
#include &lt;dmarc.h&gt;
 
15
<a href="opendmarc_status_t.html"><tt>OPENDMARC_STATUS_T</tt></a> opendmarc_policy_fetch_rf(
 
16
        <a href="dmarc_policy_t.html"><tt>DMARC_POLICY_T</tt></a> *pctx,
 
17
        int *rf
 
18
);
 
19
</pre>
 
20
Query the library to find the <tt>rf=</tt> value from the <tt>DMARC</tt> record.
 
21
</td></tr>
 
22
 
 
23
<!----------- Description ---------->
 
24
<tr><th valign="top" align=left>DESCRIPTION</th><td>
 
25
<table border="1" cellspacing=1 cellpadding=4>
 
26
<tr align="left" valign=top>
 
27
<th width="80">Called When</th>
 
28
<td><tt>opendmarc_policy_fetch_rf()</tt>
 
29
        is called after the DMARC record has been fetched and parsed.
 
30
</tr>
 
31
</table>
 
32
 
 
33
<!----------- Arguments ---------->
 
34
<tr><th valign="top" align=left>ARGUMENTS</th><td>
 
35
    <table border="1" cellspacing=0>
 
36
    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
 
37
    <tr valign="top"><td>pctx</td>
 
38
        <td>The address of a structure of type <a href="dmarc_policy_t.html">
 
39
        <tt>DMARC_POLICY_T</tt></a> as returned from <a href="opendmarc_policy_connect_init.html">opendmarc_policy_connect_init()</a>. 
 
40
        </td></tr>
 
41
    <tr valign="top"><td>rf</td>
 
42
        <td>The address of an integer to receive the value following the <tt>rf=</tt>, a value (a bitmap) of:
 
43
        <br><tt>DMARC_RECORD_RF_UNSPECIFIED</tt> if the <tt>rf=</tt> was absent or if no ruf= was specified.
 
44
        <br><tt>DMARC_RECORD_RF_AFRF</tt> if <tt>rf=afrf</tt>.
 
45
        <br><tt>DMARC_RECORD_RF_IODEF</tt> if <tt>rf=iodef</tt>.
 
46
        </td></tr>
 
47
    </table>
 
48
</td></tr>
 
49
 
 
50
<!----------- Return Values ---------->
 
51
<tr>
 
52
<th valign="top" align=left>RETURN VALUES</th> 
 
53
<td>
 
54
<ul>
 
55
<li><tt>DMARC_PARSE_OKAY</tt> -- On success.
 
56
<li><tt>DMARC_PARSE_ERROR_EMPTY</tt> -- The <tt>pctp</tt> pointer was NULL.
 
57
<li><tt>DMARC_PARSE_ERROR_NULL_CTX</tt> -- If you passed in a <tt>rf</tt> pointer value that was NULL.
 
58
</ul>
 
59
</td>
 
60
</tr>
 
61
 
 
62
<!----------- Notes ---------->
 
63
<tr>
 
64
<th valign="top" align=left>NOTES</th> 
 
65
<td>
 
66
<ul>
 
67
Call this function only after a <tt>DMARC</tt> record was fetched and parsed with
 
68
<a href="opendmarc_policy_query_dmarc.html">opendmarc_policy_query_dmarc()</a>
 
69
or supplied to the library with
 
70
<a href="opendmarc_policy_store_dmarc.html">opendmarc_policy_store_dmarc()</a>.
 
71
</ul>
 
72
</td>
 
73
</tr>
 
74
</table>
 
75
 
 
76
<hr size="1">
 
77
<font size="-1">
 
78
Copyright (c) 2012, The Trusted Domain Project.  All rights reserved.
 
79
 
 
80
<br>
 
81
By using this file, you agree to the terms and conditions set
 
82
forth in the license.
 
83
</font>
 
84
</body>
 
85
</html>