<!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"/> <title>Open SCAP Library: cpe_dict_model 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.1.1 --> <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">cpe_dict_model Struct Reference<div class="ingroups"><a class="el" href="group__cpedict.html">CPE Dictionary</a></div></div> </div> </div><!--header--> <div class="contents"> <p>Structure representing a CPE dictionary. <a href="structcpe__dict__model.html#details">More...</a></p> <p><code>#include <<a class="el" href="cpedict__priv_8h_source.html">cpedict_priv.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:ga8ba5fd300dbbff3350e27b9d5bd3c157"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpedict.html#ga8ba5fd300dbbff3350e27b9d5bd3c157">cpe_dict_model_free</a> (struct <a class="el" href="structcpe__dict__model.html">cpe_dict_model</a> *dict)</td></tr> <tr class="memitem:ga535f4d9ab9a4d63c2a8586d308b4066d"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structcpe__dict__model.html">cpe_dict_model</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpedict.html#ga535f4d9ab9a4d63c2a8586d308b4066d">cpe_dict_model_new</a> (void)</td></tr> <tr class="memitem:ga3dc08ad0483866473e5066869d5f542e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpedict.html#ga3dc08ad0483866473e5066869d5f542e">cpe_dict_model_export</a> (const struct <a class="el" href="structcpe__dict__model.html">cpe_dict_model</a> *dict, const char *file)</td></tr> <tr class="memdesc:ga3dc08ad0483866473e5066869d5f542e"><td class="mdescLeft"> </td><td class="mdescRight">Write the dict_model to a file. <a href="group__cpedict.html#ga3dc08ad0483866473e5066869d5f542e"></a><br/></td></tr> <tr class="memitem:ga0dc2738dea0113dad9a71740c216dbae"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structcpe__dict__model.html">cpe_dict_model</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpedict.html#ga0dc2738dea0113dad9a71740c216dbae">cpe_dict_model_import</a> (const char *file)</td></tr> <tr class="memdesc:ga0dc2738dea0113dad9a71740c216dbae"><td class="mdescLeft"> </td><td class="mdescRight">Load new CPE dictionary from file. <a href="group__cpedict.html#ga0dc2738dea0113dad9a71740c216dbae"></a><br/></td></tr> <tr><td colspan="2"><div class="groupHeader">Getters</div></td></tr> <tr><td colspan="2"><div class="groupText"><p>Return value is pointer to structure's member.</p> <p>Do not free unless you null the pointer in the structure. Use remove function otherwise. </p> </div></td></tr> <tr class="memitem:ga585390b1962f444e1fa4698493c16f76"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpedict.html#ga585390b1962f444e1fa4698493c16f76">cpe_dict_model_get_base_version</a> (const struct <a class="el" href="structcpe__dict__model.html">cpe_dict_model</a> *item)</td></tr> <tr class="memdesc:ga585390b1962f444e1fa4698493c16f76"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structcpe__dict__model.html" title="Structure representing a CPE dictionary.">cpe_dict_model</a> functions to get the base version from CPE dictionary model <a href="group__cpedict.html#ga585390b1962f444e1fa4698493c16f76"></a><br/></td></tr> <tr class="memitem:gaca74db255a2eca852dc40d1724ebfbc4"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpedict.html#gaca74db255a2eca852dc40d1724ebfbc4">cpe_dict_model_set_base_version</a> (struct <a class="el" href="structcpe__dict__model.html">cpe_dict_model</a> *item, int base_version)</td></tr> <tr class="memdesc:gaca74db255a2eca852dc40d1724ebfbc4"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structcpe__dict__model.html" title="Structure representing a CPE dictionary.">cpe_dict_model</a> functions to get the base version from CPE dictionary model <a href="group__cpedict.html#gaca74db255a2eca852dc40d1724ebfbc4"></a><br/></td></tr> <tr class="memitem:ga206ed522a534a6e2c91ba919ac1b00b0"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structcpe__item__iterator.html">cpe_item_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpedict.html#ga206ed522a534a6e2c91ba919ac1b00b0">cpe_dict_model_get_items</a> (const struct <a class="el" href="structcpe__dict__model.html">cpe_dict_model</a> *item)</td></tr> <tr class="memdesc:ga206ed522a534a6e2c91ba919ac1b00b0"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structcpe__dict__model.html" title="Structure representing a CPE dictionary.">cpe_dict_model</a> functions to get CPE items <a href="group__cpedict.html#ga206ed522a534a6e2c91ba919ac1b00b0"></a><br/></td></tr> <tr class="memitem:ga5e7d89457cd697fee063ba4ad41ff930"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structcpe__vendor__iterator.html">cpe_vendor_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpedict.html#ga5e7d89457cd697fee063ba4ad41ff930">cpe_dict_model_get_vendors</a> (const struct <a class="el" href="structcpe__dict__model.html">cpe_dict_model</a> *item)</td></tr> <tr class="memdesc:ga5e7d89457cd697fee063ba4ad41ff930"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structcpe__dict__model.html" title="Structure representing a CPE dictionary.">cpe_dict_model</a> functions to get vendors <a href="group__cpedict.html#ga5e7d89457cd697fee063ba4ad41ff930"></a><br/></td></tr> <tr><td colspan="2"><div class="groupHeader">Setters</div></td></tr> <tr><td colspan="2"><div class="groupText"><p>For lists use add functions.</p> <p>Parameters of set functions are duplicated in memory and need to be freed by caller. </p> </div></td></tr> <tr class="memitem:gac5c00a90ee125bc99e51abde05add610"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpedict.html#gac5c00a90ee125bc99e51abde05add610">cpe_dict_model_add_vendor</a> (struct <a class="el" href="structcpe__dict__model.html">cpe_dict_model</a> *dict, struct <a class="el" href="structcpe__vendor.html">cpe_vendor</a> *new_vendor)</td></tr> <tr><td colspan="2"><div class="groupHeader">Evaluators</div></td></tr> <tr class="memitem:ga8118960e36454c503a4681acfaba1e5e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpedict.html#ga8118960e36454c503a4681acfaba1e5e">cpe_dict_model_supported</a> (void)</td></tr> <tr class="memdesc:ga8118960e36454c503a4681acfaba1e5e"><td class="mdescLeft"> </td><td class="mdescRight">Get the newest supported version of CPE dictionary XML. <a href="group__cpedict.html#ga8118960e36454c503a4681acfaba1e5e"></a><br/></td></tr> <tr class="memitem:ga521348e593c0caf8e2f82f0729dd997c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpedict.html#ga521348e593c0caf8e2f82f0729dd997c">cpe_name_match_dict</a> (struct <a class="el" href="structcpe__name.html">cpe_name</a> *cpe, struct <a class="el" href="structcpe__dict__model.html">cpe_dict_model</a> *dict)</td></tr> <tr class="memdesc:ga521348e593c0caf8e2f82f0729dd997c"><td class="mdescLeft"> </td><td class="mdescRight">Verify wether given CPE is known according to specified dictionary. <a href="group__cpedict.html#ga521348e593c0caf8e2f82f0729dd997c"></a><br/></td></tr> <tr class="memitem:ga0bf19ab90612cb4af8931d83b51e59d6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpedict.html#ga0bf19ab90612cb4af8931d83b51e59d6">cpe_name_match_dict_str</a> (const char *cpe, struct <a class="el" href="structcpe__dict__model.html">cpe_dict_model</a> *dict)</td></tr> <tr class="memdesc:ga0bf19ab90612cb4af8931d83b51e59d6"><td class="mdescLeft"> </td><td class="mdescRight">Verify if CPE given by string is known according to specified dictionary. <a href="group__cpedict.html#ga0bf19ab90612cb4af8931d83b51e59d6"></a><br/></td></tr> <tr class="memitem:gac88ace404a10736c5493d08846598f60"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpedict.html#gac88ace404a10736c5493d08846598f60">cpe_name_applicable_dict</a> (struct <a class="el" href="structcpe__name.html">cpe_name</a> *cpe, struct <a class="el" href="structcpe__dict__model.html">cpe_dict_model</a> *dict, <a class="el" href="cpe__name_8h.html#acd5b9dfed7f43c5d019c633fcaa73e35">cpe_check_fn</a> cb, void *usr)</td></tr> <tr class="memdesc:gac88ace404a10736c5493d08846598f60"><td class="mdescLeft"> </td><td class="mdescRight">Verify whether given CPE is applicable to current platform by evaluating checks associated with it. <a href="group__cpedict.html#gac88ace404a10736c5493d08846598f60"></a><br/></td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2><a name="pub-attribs"></a> Data Fields</h2></td></tr> <tr class="memitem:a091dc0d93b41200735c68632c07302e9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a091dc0d93b41200735c68632c07302e9"></a> struct <a class="el" href="structoscap__list.html">oscap_list</a> * </td><td class="memItemRight" valign="bottom"><b>items</b></td></tr> <tr class="memitem:a2c59f354beda65b36c5e1e2dbe116db2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c59f354beda65b36c5e1e2dbe116db2"></a> struct <a class="el" href="structoscap__list.html">oscap_list</a> * </td><td class="memItemRight" valign="bottom"><b>vendors</b></td></tr> <tr class="memitem:a40485ff35e342cf97fee5c425e493f2a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40485ff35e342cf97fee5c425e493f2a"></a> int </td><td class="memItemRight" valign="bottom"><b>base_version</b></td></tr> <tr class="memitem:a380baade2f244818b3b01fb54d14c441"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a380baade2f244818b3b01fb54d14c441"></a> struct <a class="el" href="structcpe__generator.html">cpe_generator</a> * </td><td class="memItemRight" valign="bottom"><b>generator</b></td></tr> <tr class="memitem:a6b5387e0416a9d60e48db4658dbea941"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6b5387e0416a9d60e48db4658dbea941"></a> char * </td><td class="memItemRight" valign="bottom"><b>origin_file</b></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Structure representing a CPE dictionary. </p> </div><hr/>The documentation for this struct was generated from the following files:<ul> <li><a class="el" href="cpedict__priv_8h_source.html">cpedict_priv.h</a></li> <li><a class="el" href="cpe__dict_8h_source.html">cpe_dict.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.1.1 </small></address> </body> </html>