<html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii"/> <title>mail::ACCOUNT::getFolderKeywordInfo</title> <link rel="stylesheet" href="manpage.css" type="text/css"/> <link rel="start" href="index.html" title="Cone: COnsole Newsreader And Emailer"/> <link rel="up" href="synchronous.html" title="mail::ACCOUNT Synchronous API reference"/> <link rel="prev" href="account-getfolderfromstring.html" title="mail::ACCOUNT::getFolderFromString"/> <link rel="next" href="account-getmessagecontent.html" title="mail::ACCOUNT::getMessageContent"/> <link xmlns="" rel="icon" href="icon.gif" type="image/gif"/> <meta xmlns="" name="MSSmartTagsPreventParsing" content="TRUE"/> <!-- Copyright 2002 - 2007 Double Precision, Inc. See COPYING for distribution information. --> </head> <body> <div class="navheader"> <table width="100%" summary="Navigation header"> <tr> <th colspan="3" align="center" rowspan="1"> mail::ACCOUNT::getFolderKeywordInfo</th> </tr> <tr> <td width="20%" align="left" rowspan="1" colspan="1"> <a accesskey="p" href="account-getfolderfromstring.html" shape="rect">Prev</a> </td> <th width="60%" align="center" rowspan="1" colspan="1"> <span class="structname">mail::ACCOUNT</span> Synchronous API reference</th> <td width="20%" align="right" rowspan="1" colspan="1">  <a accesskey="n" href="account-getmessagecontent.html" shape="rect">Next</a></td> </tr> </table> <hr/> </div> <div class="refentry" lang="en" xml:lang="en"> <a id="account-getfolderkeywordinfo" shape="rect" name="account-getfolderkeywordinfo"> </a> <div class="titlepage"/> <div class="refnamediv"> <h2>Name</h2> <p>mail::ACCOUNT::getFolderKeywordInfo — Return message keywords</p> </div> <div class="refsynopsisdiv"> <h2>Synopsis</h2> <div class="literallayout"> <p><br clear="none"/> <br clear="none"/> <br clear="none"/> <br clear="none"/> #include <libmail/sync.H><br clear="none"/> <br clear="none"/> <br clear="none"/> mail::ACCOUNT *mail;<br clear="none"/></p> </div> <div class="funcsynopsis"> <table border="0" summary="Function synopsis" cellspacing="0" cellpadding="0"> <tr> <td rowspan="1" colspan="1"><code class="funcdef">bool ok=mail-><b class="fsfunc">getFolderKeywordInfo</b>(</code></td> <td rowspan="1" colspan="1">size_t  </td> <td rowspan="1" colspan="1"><var class="pdparam">messageNum</var>,</td> </tr> <tr> <td rowspan="1" colspan="1"> </td> <td rowspan="1" colspan="1">std::set<std::string> & </td> <td rowspan="1" colspan="1"><var class="pdparam">keywords</var><code>)</code>;</td> </tr> </table> </div> </div> <div class="refsect1" lang="en" xml:lang="en"> <a id="id560559" shape="rect" name="id560559"> </a> <h2>USAGE</h2> <p><code class="function">mail::ACCOUNT::getFolderKeywordInfo</code> retrieves the current keywords for message #<em class="parameter"><code>messagenum</code></em> and places them into <em class="parameter"><code>keywords</code></em> (removing any existing contents). If the message does not have any keywords set, <em class="parameter"><code>keywords</code></em> will be an empty set. <em class="parameter"><code>messageNum</code></em> must be between zero and one less than the return code from <a class="link" href="account-getfolderindexsize.html" title="mail::ACCOUNT::getFolderIndexSize" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::getFolderIndexSize</span>(3x)</span></a>.</p> </div> <div class="refsect1" lang="en" xml:lang="en"> <a id="id560621" shape="rect" name="id560621"> </a> <h2>Return Codes</h2> <p>This function returns immediately.</p> </div> <div class="refsect1" lang="en" xml:lang="en"> <a id="id560631" shape="rect" name="id560631"> </a> <h2>SEE ALSO</h2> <p><a class="link" href="account-getfolderindexsize.html" title="mail::ACCOUNT::getFolderIndexSize" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::getFolderIndexSize</span>(3x)</span></a>, <a class="link" href="account-getfolderindexinfo.html" title="mail::ACCOUNT::getFolderIndexInfo" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::getFolderIndexInfo</span>(3x)</span></a>, <a class="link" href="account-updatekeywords.html" title="mail::ACCOUNT::updateKeywords" shape="rect"><span class="citerefentry"><span class="refentrytitle">mail::ACCOUNT::updateKeywords</span>(3x)</span></a>.</p> </div> </div> <div class="navfooter"> <hr/> <table width="100%" summary="Navigation footer"> <tr> <td width="40%" align="left" rowspan="1" colspan="1"> <a accesskey="p" href="account-getfolderfromstring.html" shape="rect">Prev</a> </td> <td width="20%" align="center" rowspan="1" colspan="1"> <a accesskey="u" href="synchronous.html" shape="rect">Up</a></td> <td width="40%" align="right" rowspan="1" colspan="1">  <a accesskey="n" href="account-getmessagecontent.html" shape="rect">Next</a></td> </tr> <tr> <td width="40%" align="left" valign="top" rowspan="1" colspan="1">mail::ACCOUNT::getFolderFromString </td> <td width="20%" align="center" rowspan="1" colspan="1"> <a accesskey="h" href="index.html" shape="rect">Home</a> | <a accesskey="t" href="bk01-toc.html" shape="rect">ToC</a></td> <td width="40%" align="right" valign="top" rowspan="1" colspan="1"> mail::ACCOUNT::getMessageContent</td> </tr> </table> </div> </body> </html>