<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.6"/> <title>Open SCAP Library: oscap_string_map Struct Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Open SCAP Library </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.6 --> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="classes.html"><span>Data Structure Index</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-attribs">Data Fields</a> </div> <div class="headertitle"> <div class="title">oscap_string_map Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p>Define mapping between symbolic constant and its string representation. <a href="structoscap__string__map.html#details">More...</a></p> <p><code>#include <<a class="el" href="util_8h_source.html">util.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a6bda0f46c76ca15d381bbc08d932dfaa"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structoscap__string__map.html#a6bda0f46c76ca15d381bbc08d932dfaa">oscap_string_to_enum</a> (const struct <a class="el" href="structoscap__string__map.html">oscap_string_map</a> *map, const char *str)</td></tr> <tr class="memdesc:a6bda0f46c76ca15d381bbc08d932dfaa"><td class="mdescLeft"> </td><td class="mdescRight">Convert a string to an enumeration constant. <a href="#a6bda0f46c76ca15d381bbc08d932dfaa">More...</a><br/></td></tr> <tr class="separator:a6bda0f46c76ca15d381bbc08d932dfaa"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa1d9de0387526ec8dbb26b494ef1703d"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structoscap__string__map.html#aa1d9de0387526ec8dbb26b494ef1703d">oscap_enum_to_string</a> (const struct <a class="el" href="structoscap__string__map.html">oscap_string_map</a> *map, int val)</td></tr> <tr class="memdesc:aa1d9de0387526ec8dbb26b494ef1703d"><td class="mdescLeft"> </td><td class="mdescRight">Convert an enumeration constant to its corresponding string representation. <a href="#aa1d9de0387526ec8dbb26b494ef1703d">More...</a><br/></td></tr> <tr class="separator:aa1d9de0387526ec8dbb26b494ef1703d"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> Data Fields</h2></td></tr> <tr class="memitem:a9829b586421a58d05b777b7c04f26394"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9829b586421a58d05b777b7c04f26394"></a> int </td><td class="memItemRight" valign="bottom"><b>value</b></td></tr> <tr class="separator:a9829b586421a58d05b777b7c04f26394"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:adf5a6e02a988e5285f7bef49625127c0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf5a6e02a988e5285f7bef49625127c0"></a> const char * </td><td class="memItemRight" valign="bottom"><b>string</b></td></tr> <tr class="separator:adf5a6e02a988e5285f7bef49625127c0"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Define mapping between symbolic constant and its string representation. </p> <p>It is supposed to define array of these structures, ending with element with the <em>string</em> member set to NULL. Value of such member also defines the default value for strings not defined elsewhere. </p> </div><h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="aa1d9de0387526ec8dbb26b494ef1703d"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char * oscap_enum_to_string </td> <td>(</td> <td class="paramtype">const struct <a class="el" href="structoscap__string__map.html">oscap_string_map</a> * </td> <td class="paramname"><em>map</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"><em>val</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Convert an enumeration constant to its corresponding string representation. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">map</td><td>An array of <a class="el" href="structoscap__string__map.html" title="Define mapping between symbolic constant and its string representation. ">oscap_string_map</a> structures that defines mapping between constants and strings. </td></tr> <tr><td class="paramname">val</td><td>value to be converted </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a6bda0f46c76ca15d381bbc08d932dfaa"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int oscap_string_to_enum </td> <td>(</td> <td class="paramtype">const struct <a class="el" href="structoscap__string__map.html">oscap_string_map</a> * </td> <td class="paramname"><em>map</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const char * </td> <td class="paramname"><em>str</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Convert a string to an enumeration constant. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">map</td><td>An array of <a class="el" href="structoscap__string__map.html" title="Define mapping between symbolic constant and its string representation. ">oscap_string_map</a> structures that defines mapping between constants and strings. </td></tr> <tr><td class="paramname">str</td><td>string to be converted </td></tr> </table> </dd> </dl> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="util_8h_source.html">util.h</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.6 </small></address> </body> </html>