<!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"/>
<title>Open SCAP Library: cpe_dict_model Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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 class="tabs">
<ul>
<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>
<div class="contents">
<h1>cpe_dict_model Struct Reference<br/>
<small>
[<a class="el" href="group__CPEDictPrivate.html">Private members</a>, <a class="el" href="group__cpedict.html">CPE Dictionary</a>]</small>
</h1><!-- doxytag: class="cpe_dict_model" -->
<p>Structure representing a CPE dictionary.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="cpedict__priv_8h_source.html">cpedict_priv.h</a>></code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Parse functions</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp55bde346b0631e090bfc4a3be713ee4c"></a>Functions for parsing structures from XML.</p>
<p>Return value is new structure filled by content of XML file represented by XML reader or import source structure. Structure needs to be freed by the caller. </p>
<br/><br/></div></td></tr>
<tr><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__CPEDictPrivate.html#gab330e1ce3e13aaf31edbe7d77f1530e5">cpe_dict_model_parse_xml</a> (const struct <a class="el" href="structoscap__import__source.html">oscap_import_source</a> *source)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Function to parse XML to CPE dictionary model. <a href="group__CPEDictPrivate.html#gab330e1ce3e13aaf31edbe7d77f1530e5"></a><br/></td></tr>
<tr><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__CPEDictPrivate.html#ga47dbcfc19a27100a459f3ef19d84418f">cpe_dict_model_parse</a> (xmlTextReaderPtr reader)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load new CPE dictionary from XML node. <a href="group__CPEDictPrivate.html#ga47dbcfc19a27100a459f3ef19d84418f"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Export functions</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp5713b34587ba18c5a4561b737b639ae5"></a>Functions for export structures to XML by XML writer.</p>
<p>Exported structures need to be freed by the caller. </p>
<br/><br/></div></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CPEDictPrivate.html#gaf69b63b2cded5f672bea7e93c730ac2b">cpe_dict_model_export_xml</a> (const struct <a class="el" href="structcpe__dict__model.html">cpe_dict_model</a> *dict, const struct <a class="el" href="structoscap__export__target.html">oscap_export_target</a> *target)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Export function for CPE dictionary model. <a href="group__CPEDictPrivate.html#gaf69b63b2cded5f672bea7e93c730ac2b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__CPEDictPrivate.html#gaa67e4679e6c485673692d0807d0d0a99">cpe_dict_export</a> (const struct <a class="el" href="structcpe__dict__model.html">cpe_dict_model</a> *dict, xmlTextWriterPtr writer)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Internal export function for CPE dictionary model. <a href="group__CPEDictPrivate.html#gaa67e4679e6c485673692d0807d0d0a99"></a><br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Get functions</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpc2ac1eb4de8ec5add5567cbae2f237e5"></a>Functions for getting attributes from CVE model structures.</p>
<p>Return value is pointer to structure's member. Do not free unless you null the pointer in the structure. Use remove function otherwise. </p>
<br/><br/></div></td></tr>
<tr><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><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><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><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 class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7ddb03a5ffd1f967c722915f00d2e9c0"></a><!-- doxytag: member="cpe_dict_model::cpe_dict_model_get_xmlns" ref="ga7ddb03a5ffd1f967c722915f00d2e9c0" args="(const struct cpe_dict_model *model)" -->
struct <a class="el" href="structxml__metadata__iterator.html">xml_metadata_iterator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpedict.html#ga7ddb03a5ffd1f967c722915f00d2e9c0">cpe_dict_model_get_xmlns</a> (const struct <a class="el" href="structcpe__dict__model.html">cpe_dict_model</a> *model)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get XML namespace from CPE dict model. <br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Free functions</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp237dd65bc76b7de56066830910ced6ed"></a>Destructors of CVE model structures.</p>
<p>Functions free structures with all members recursively. For simple deletion of entity use remove functions. </p>
<br/><br/></div></td></tr>
<tr><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><td colspan="2"><div class="groupHeader">New functions</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrp73a4128f20867fa23ebb2e75e58922df"></a>Constructors of CVE model structures.</p>
<p>Free function returns new empty allocated structure. If returns non NULL it need to be freed by the caller. </p>
<br/><br/></div></td></tr>
<tr><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><td colspan="2"><div class="groupHeader">Add functions</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpaabced06c8a2e8c15954ce4b1e334884"></a>Functions to add member to list.</p>
<p>Return value is true if added succesfuly or false in case of error. </p>
<br/><br/></div></td></tr>
<tr><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 class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaeab13506267f399e19ea06ae98b127d4"></a><!-- doxytag: member="cpe_dict_model::cpe_dict_model_add_xml" ref="gaeab13506267f399e19ea06ae98b127d4" args="(struct cpe_dict_model *model, struct xml_metadata *xml)" -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpedict.html#gaeab13506267f399e19ea06ae98b127d4">cpe_dict_model_add_xml</a> (struct <a class="el" href="structcpe__dict__model.html">cpe_dict_model</a> *model, struct <a class="el" href="structxml__metadata.html">xml_metadata</a> *xml)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add XML namespace to CPE dict model. <br/></td></tr>
<tr><td colspan="2"><div class="groupHeader">Other functions</div></td></tr>
<tr><td colspan="2"><div class="groupText"><p><a class="anchor" id="amgrpb175402ebe89f00c62233c5453c5a243"></a> </p>
<br/><br/></div></td></tr>
<tr><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><td class="mdescLeft"> </td><td class="mdescRight">Get supported version of CPE dictionary XML. <a href="group__cpedict.html#ga8118960e36454c503a4681acfaba1e5e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpedict.html#ga5c58082a1bb06b72fc48ddf01bc965e5">cpe_dict_model_export</a> (const struct <a class="el" href="structcpe__dict__model.html">cpe_dict_model</a> *dict, const struct <a class="el" href="structoscap__export__target.html">oscap_export_target</a> *target)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write the dict_model to a file. <a href="group__cpedict.html#ga5c58082a1bb06b72fc48ddf01bc965e5"></a><br/></td></tr>
<tr><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#gae03243aeacaafbfcdd3a06cf8317a9d8">cpe_dict_model_import</a> (const struct <a class="el" href="structoscap__import__source.html">oscap_import_source</a> *source)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load new CPE dictionary from file. <a href="group__cpedict.html#gae03243aeacaafbfcdd3a06cf8317a9d8"></a><br/></td></tr>
<tr><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><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><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><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><td colspan="2"><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab432bc56eb9402a6e759810260f217f0"></a><!-- doxytag: member="cpe_dict_model::xmlns" ref="ab432bc56eb9402a6e759810260f217f0" args="" -->
struct <a class="el" href="structoscap__list.html">oscap_list</a> * </td><td class="memItemRight" valign="bottom"><b>xmlns</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa2ceb8082159c49d83baa52a976203f"></a><!-- doxytag: member="cpe_dict_model::xml" ref="afa2ceb8082159c49d83baa52a976203f" args="" -->
struct <a class="el" href="structxml__metadata.html">xml_metadata</a> </td><td class="memItemRight" valign="bottom"><b>xml</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a091dc0d93b41200735c68632c07302e9"></a><!-- doxytag: member="cpe_dict_model::items" ref="a091dc0d93b41200735c68632c07302e9" args="" -->
struct <a class="el" href="structoscap__list.html">oscap_list</a> * </td><td class="memItemRight" valign="bottom"><b>items</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c59f354beda65b36c5e1e2dbe116db2"></a><!-- doxytag: member="cpe_dict_model::vendors" ref="a2c59f354beda65b36c5e1e2dbe116db2" args="" -->
struct <a class="el" href="structoscap__list.html">oscap_list</a> * </td><td class="memItemRight" valign="bottom"><b>vendors</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a380baade2f244818b3b01fb54d14c441"></a><!-- doxytag: member="cpe_dict_model::generator" ref="a380baade2f244818b3b01fb54d14c441" args="" -->
struct <a class="el" href="structcpe__generator.html">cpe_generator</a> * </td><td class="memItemRight" valign="bottom"><b>generator</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Structure representing a CPE dictionary. </p>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>/home/pvrabec/openscap/openscap-0.5.7/src/CPE/<a class="el" href="cpedict__priv_8c.html">cpedict_priv.c</a></li>
<li>/home/pvrabec/openscap/openscap-0.5.7/src/CPE/<a class="el" href="cpedict__priv_8h_source.html">cpedict_priv.h</a></li>
<li>/home/pvrabec/openscap/openscap-0.5.7/src/CPE/public/<a class="el" href="cpedict_8h_source.html">cpedict.h</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on 26 Feb 2010 for Open SCAP Library by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>
