2
<head><title>opendmarc_policy_fetch_ruf()</title></head>
5
$Id: opendmarc_policy_fetch_ruf.html,v 1.5 2010/07/24 04:52:15 cm-msk Exp $
7
<h1>opendmarc_policy_fetch_ruf()</h1>
8
<p align="right"><a href="index.html">[back to index]</a></p>
10
<table border="0" cellspacing=4 cellpadding=4>
11
<!---------- Synopsis ----------->
12
<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
14
#include <dmarc.h>
15
u_char ** opendmarc_policy_fetch_ruf(
16
<a href="dmarc_policy_t.html"><tt>DMARC_POLICY_T</tt></a> *pctx,
17
u_char *list_buf, size_t size_of_buf, int constant
20
Query the library to find the list of <tt>ruf=</tt> values from the <tt>DMARC</tt> record.
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_ruf()</tt>
29
is called after the DMARC record has been fetched and parsed.
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>.
41
<tr valign="top"><td>list_buf</td>
42
<td>If not NULL, the address of a buffer to receive a comma delimited list as a single string.
44
<tr valign="top"><td>size_of_buf</td>
45
<td>If <tt>list_buf</tt> was not NULL, the the length of that buffer in bytes.
47
<tr valign="top"><td>constant</td>
48
<td>This function returns an argv-style array of stings. Set this to 0 if you will free that array
49
when you are finished with it. Set this to 1 if you want to treat that array as const and have
50
the library magically free it for you.
55
<!----------- Return Values ---------->
57
<th valign="top" align=left>RETURN VALUES</th>
60
<li><tt>!= NULL</tt> -- On success.
61
<li><tt>NULL</tt> -- The <tt>pctp</tt> pointer was NULL.
62
<li><tt>NULL</tt> -- If the <tt>DMARC</tt> record contained no <tt>ruf=</tt>
67
<!----------- Notes ---------->
69
<th valign="top" align=left>NOTES</th>
72
<li>If you set <tt>constant</tt> to 1, you must not free the array returned. To do so will have unpredictable results.
73
<li>Call this function only after a <tt>DMARC</tt> record was fetched and parsed with
74
<a href="opendmarc_policy_query_dmarc.html">opendmarc_policy_query_dmarc()</a>
75
or supplied to the library with
76
<a href="opendmarc_policy_store_dmarc.html">opendmarc_policy_store_dmarc()</a>.
84
Copyright (c) 2012, The Trusted Domain Project. All rights reserved.
87
By using this file, you agree to the terms and conditions set
added
removed
libopendmarc/docs/opendmarc_policy_fetch_ruf.html
