<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>libzypp: zypp/APIConfig.h File 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="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(initResizable); /* @license-end */</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 id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">libzypp  <span id="projectnumber">17.9.0</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function(){initNavTree('APIConfig_8h.html','');}); /* @license-end */ </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#define-members">Macros</a> </div> <div class="headertitle"> <div class="title">APIConfig.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>Provides API related macros. <a href="#details">More...</a></p> <div class="textblock"><code>#include "<a class="el" href="Easy_8h_source.html">zypp/base/Easy.h</a>"</code><br /> </div><div class="textblock"><div class="dynheader"> Include dependency graph for APIConfig.h:</div> <div class="dyncontent"> <div class="center"><img src="APIConfig_8h__incl.png" border="0" usemap="#zypp_2APIConfig_8h" alt=""/></div> <map name="zypp_2APIConfig_8h" id="zypp_2APIConfig_8h"> <area shape="rect" title="Provides API related macros." alt="" coords="5,5,135,32"/> <area shape="rect" href="Easy_8h.html" title=" " alt="" coords="7,80,133,107"/> <area shape="rect" title=" " alt="" coords="41,155,99,181"/> </map> </div> </div><div class="textblock"><div class="dynheader"> This graph shows which files directly or indirectly include this file:</div> <div class="dyncontent"> <div class="center"><img src="APIConfig_8h__dep__incl.png" border="0" usemap="#zypp_2APIConfig_8hdep" alt=""/></div> <map name="zypp_2APIConfig_8hdep" id="zypp_2APIConfig_8hdep"> <area shape="rect" title="Provides API related macros." alt="" coords="4569,5,4698,32"/> <area shape="rect" href="CleanerThread__p_8h.html" title="This file contains private API, it will change without notice." alt="" coords="209,162,415,189"/> <area shape="rect" href="LogTools_8h.html" title=" " alt="" coords="2465,162,2623,189"/> <area shape="rect" href="pool_2PoolImpl_8h.html" title=" " alt="" coords="4006,251,4162,278"/> <area shape="rect" href="Capability_8h.html" title=" " alt="" coords="4621,80,4747,107"/> <area shape="rect" href="ExternalProgram_8h.html" title=" " alt="" coords="596,162,767,189"/> <area shape="rect" href="HistoryLogData_8h.html" title=" " alt="" coords="4772,80,4935,107"/> <area shape="rect" href="MediaAccess_8h.html" title=" " alt="" coords="3880,80,4067,107"/> <area shape="rect" href="MediaManager_8h.html" title=" " alt="" coords="3805,162,4005,189"/> <area shape="rect" href="MediaHandler_8h.html" title=" " alt="" coords="4632,162,4827,189"/> <area shape="rect" href="MediaUserAuth_8h.html" title="Convenience interface for handling authentication data of media user." alt="" coords="4959,80,5161,107"/> <area shape="rect" href="OnMediaLocation_8h.html" title=" " alt="" coords="5186,80,5361,107"/> <area shape="rect" href="XmlEscape_8h.html" title=" " alt="" coords="5385,80,5588,107"/> <area shape="rect" href="RepoInfoBase_8h.html" title=" " alt="" coords="5663,80,5849,107"/> <area shape="rect" href="RepoInfo_8h.html" title=" " alt="" coords="5629,162,5753,189"/> <area shape="rect" href="ResKind_8h.html" title=" " alt="" coords="5874,80,5990,107"/> <area shape="rect" href="ResObject_8h.html" title=" " alt="" coords="6016,162,6144,189"/> <area shape="rect" href="Resolvable_8h.html" title=" " alt="" coords="6065,80,6199,107"/> <area shape="rect" href="ResPool_8h.html" title=" " alt="" coords="4276,80,4393,107"/> <area shape="rect" href="Target_8h.html" title=" " alt="" coords="4360,162,4467,189"/> <area shape="rect" href="ZYpp_8h.html" title=" " alt="" coords="4873,251,4973,278"/> <area shape="rect" href="ShutdownLock__p_8h.html" title=" " alt="" coords="6223,80,6396,107"/> <area shape="rect" href="WebpinResult_8h.html" title=" " alt="" coords="6421,80,6595,107"/> <area shape="rect" href="ZConfig_8h.html" title=" " alt="" coords="4491,162,4608,189"/> <area shape="rect" href="ZYppReadOnlyHack_8h.html" title=" " alt="" coords="4141,155,4336,196"/> <area shape="rect" href="CleanerThread_8cc.html" title=" " alt="" coords="5,251,200,278"/> <area shape="rect" href="ExternalProgram_8cc.html" title=" " alt="" coords="225,251,399,278"/> <area shape="rect" href="Backtrace_8cc.html" title=" " alt="" coords="3444,251,3607,278"/> <area shape="rect" href="Exception_8cc.html" title=" " alt="" coords="3631,251,3793,278"/> <area shape="rect" href="GzStream_8cc.html" title=" " alt="" coords="3818,251,3982,278"/> <area shape="rect" href="InputStream_8cc.html" title=" " alt="" coords="986,251,1166,278"/> <area shape="rect" href="String_8cc.html" title=" " alt="" coords="1191,251,1332,278"/> <area shape="rect" href="StrMatcher_8cc.html" title=" " alt="" coords="1357,251,1529,278"/> <area shape="rect" href="Capabilities_8cc.html" title=" " alt="" coords="1553,251,1695,278"/> <area shape="rect" href="CpeId_8cc.html" title=" " alt="" coords="1932,251,2039,278"/> <area shape="rect" href="DiskUsageCounter_8cc.html" title=" " alt="" coords="475,251,658,278"/> <area shape="rect" href="Fetcher_8cc.html" title=" " alt="" coords="2063,251,2180,278"/> <area shape="rect" href="Glob_8cc.html" title=" " alt="" coords="2204,251,2305,278"/> <area shape="rect" href="KeyRing_8cc.html" title=" " alt="" coords="888,333,1008,360"/> <area shape="rect" href="Locks_8cc.html" title=" " alt="" coords="2330,251,2435,278"/> <area shape="rect" href="MediaHandler_8cc.html" title=" " alt="" coords="4650,251,4849,278"/> <area shape="rect" href="MediaPlugin_8cc.html" title=" " alt="" coords="1719,251,1907,278"/> <area shape="rect" href="MediaPriority_8cc.html" title=" " alt="" coords="4433,251,4626,278"/> <area shape="rect" href="MediaSetAccess_8cc.html" title=" " alt="" coords="2460,251,2628,278"/> <area shape="rect" href="CheckAccessDeleted_8cc.html" title=" " alt="" coords="682,251,910,278"/> <area shape="rect" href="DefaultLoadSystem_8cc.html" title=" " alt="" coords="4186,251,4409,278"/> <area shape="rect" href="RepoFileReader_8cc.html" title=" " alt="" coords="2652,251,2863,278"/> <area shape="rect" href="ContentFileReader_8cc.html" title=" " alt="" coords="2887,244,3046,285"/> <area shape="rect" href="RepoIndex_8cc.html" title=" " alt="" coords="3070,244,3221,285"/> <area shape="rect" href="Node_8cc.html" title=" " alt="" coords="3245,251,3419,278"/> </map> </div> </div> <p><a href="APIConfig_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:ad70d9fc326091669b78cafc28d02ef56"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="APIConfig_8h.html#ad70d9fc326091669b78cafc28d02ef56">ZYPP_DECL_EXPORT</a></td></tr> <tr class="memdesc:ad70d9fc326091669b78cafc28d02ef56"><td class="mdescLeft"> </td><td class="mdescRight">Generic helper definitions for shared library support. <a href="#ad70d9fc326091669b78cafc28d02ef56">More...</a><br /></td></tr> <tr class="separator:ad70d9fc326091669b78cafc28d02ef56"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a09c0030844e0b0c261ac530398038314"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="APIConfig_8h.html#a09c0030844e0b0c261ac530398038314">ZYPP_DECL_IMPORT</a></td></tr> <tr class="separator:a09c0030844e0b0c261ac530398038314"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a36528aa4a716e585dc18a351dae54c91"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="APIConfig_8h.html#a36528aa4a716e585dc18a351dae54c91">ZYPP_DECL_HIDDEN</a></td></tr> <tr class="separator:a36528aa4a716e585dc18a351dae54c91"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a7574b0cd80b20e8aeb709e0337b857b6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="APIConfig_8h.html#a7574b0cd80b20e8aeb709e0337b857b6">ZYPP_API</a>   <a class="el" href="APIConfig_8h.html#a09c0030844e0b0c261ac530398038314">ZYPP_DECL_IMPORT</a></td></tr> <tr class="separator:a7574b0cd80b20e8aeb709e0337b857b6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5e0f3bfd93e9573391e2e79c0e0564e8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="APIConfig_8h.html#a5e0f3bfd93e9573391e2e79c0e0564e8">ZYPP_LOCAL</a></td></tr> <tr class="separator:a5e0f3bfd93e9573391e2e79c0e0564e8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a62eda8dfb49f55d460b679db0dc08e25"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="APIConfig_8h.html#a62eda8dfb49f55d460b679db0dc08e25">ZYPP_DEPRECATED</a></td></tr> <tr class="memdesc:a62eda8dfb49f55d460b679db0dc08e25"><td class="mdescLeft"> </td><td class="mdescRight">The ZYPP_DEPRECATED macro can be used to trigger compile-time warnings with gcc >= 3.2 when deprecated functions are used. <a href="#a62eda8dfb49f55d460b679db0dc08e25">More...</a><br /></td></tr> <tr class="separator:a62eda8dfb49f55d460b679db0dc08e25"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Provides API related macros. </p> <p class="definition">Definition in file <a class="el" href="APIConfig_8h_source.html">APIConfig.h</a>.</p> </div><h2 class="groupheader">Macro Definition Documentation</h2> <a id="ad70d9fc326091669b78cafc28d02ef56"></a> <h2 class="memtitle"><span class="permalink"><a href="#ad70d9fc326091669b78cafc28d02ef56">◆ </a></span>ZYPP_DECL_EXPORT</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ZYPP_DECL_EXPORT</td> </tr> </table> </div><div class="memdoc"> <p>Generic helper definitions for shared library support. </p> <dl class="section see"><dt>See also</dt><dd>e.g. <a href="http://gcc.gnu.org/wiki/Visibility">http://gcc.gnu.org/wiki/Visibility</a> <div class="fragment"><div class="line"><span class="keyword">extern</span> <span class="stringliteral">"C"</span> <a class="code" href="APIConfig_8h.html#a7574b0cd80b20e8aeb709e0337b857b6">ZYPP_API</a> <span class="keywordtype">void</span> <span class="keyword">function</span>(<span class="keywordtype">int</span> a);</div><div class="line"><span class="keyword">class </span><a class="code" href="APIConfig_8h.html#a7574b0cd80b20e8aeb709e0337b857b6">ZYPP_API</a> SomeClass</div><div class="line">{</div><div class="line"> <span class="keywordtype">int</span> c;</div><div class="line"> <a class="code" href="APIConfig_8h.html#a5e0f3bfd93e9573391e2e79c0e0564e8">ZYPP_LOCAL</a> <span class="keywordtype">void</span> privateMethod(); <span class="comment">// Only for use within this DSO</span></div><div class="line"><span class="keyword">public</span>:</div><div class="line"> Person(<span class="keywordtype">int</span> _c) : c(_c) { }</div><div class="line"> <span class="keyword">static</span> <span class="keywordtype">void</span> foo(<span class="keywordtype">int</span> a);</div><div class="line">};</div></div><!-- fragment --> }; </dd></dl> <p class="definition">Definition at line <a class="el" href="APIConfig_8h_source.html#l00038">38</a> of file <a class="el" href="APIConfig_8h_source.html">APIConfig.h</a>.</p> </div> </div> <a id="a09c0030844e0b0c261ac530398038314"></a> <h2 class="memtitle"><span class="permalink"><a href="#a09c0030844e0b0c261ac530398038314">◆ </a></span>ZYPP_DECL_IMPORT</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ZYPP_DECL_IMPORT</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="APIConfig_8h_source.html#l00039">39</a> of file <a class="el" href="APIConfig_8h_source.html">APIConfig.h</a>.</p> </div> </div> <a id="a36528aa4a716e585dc18a351dae54c91"></a> <h2 class="memtitle"><span class="permalink"><a href="#a36528aa4a716e585dc18a351dae54c91">◆ </a></span>ZYPP_DECL_HIDDEN</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ZYPP_DECL_HIDDEN</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="APIConfig_8h_source.html#l00040">40</a> of file <a class="el" href="APIConfig_8h_source.html">APIConfig.h</a>.</p> </div> </div> <a id="a7574b0cd80b20e8aeb709e0337b857b6"></a> <h2 class="memtitle"><span class="permalink"><a href="#a7574b0cd80b20e8aeb709e0337b857b6">◆ </a></span>ZYPP_API</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ZYPP_API   <a class="el" href="APIConfig_8h.html#a09c0030844e0b0c261ac530398038314">ZYPP_DECL_IMPORT</a></td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="APIConfig_8h_source.html#l00047">47</a> of file <a class="el" href="APIConfig_8h_source.html">APIConfig.h</a>.</p> </div> </div> <a id="a5e0f3bfd93e9573391e2e79c0e0564e8"></a> <h2 class="memtitle"><span class="permalink"><a href="#a5e0f3bfd93e9573391e2e79c0e0564e8">◆ </a></span>ZYPP_LOCAL</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ZYPP_LOCAL</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="APIConfig_8h_source.html#l00048">48</a> of file <a class="el" href="APIConfig_8h_source.html">APIConfig.h</a>.</p> </div> </div> <a id="a62eda8dfb49f55d460b679db0dc08e25"></a> <h2 class="memtitle"><span class="permalink"><a href="#a62eda8dfb49f55d460b679db0dc08e25">◆ </a></span>ZYPP_DEPRECATED</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ZYPP_DEPRECATED</td> </tr> </table> </div><div class="memdoc"> <p>The ZYPP_DEPRECATED macro can be used to trigger compile-time warnings with gcc >= 3.2 when deprecated functions are used. </p> <p>For non-inline functions, the macro is used at the very end of the function declaration, right before the semicolon, unless it's pure virtual:</p> <p>int deprecatedFunc() const ZYPP_DEPRECATED; virtual int deprecatedPureVirtualFunc() const ZYPP_DEPRECATED = 0;</p> <p>Functions which are implemented inline are handled differently: the ZYPP_DEPRECATED macro is used at the front, right before the return type, but after "static" or "virtual":</p> <p>ZYPP_DEPRECATED void deprecatedFuncA() { .. } virtual ZYPP_DEPRECATED int deprecatedFuncB() { .. } static ZYPP_DEPRECATED bool deprecatedFuncC() { .. }</p> <p>You can also mark whole structs or classes as deprecated, by inserting the ZYPP_DEPRECATED macro after the struct/class keyword, but before the name of the struct/class:</p> <p>class ZYPP_DEPRECATED DeprecatedClass { }; struct ZYPP_DEPRECATED DeprecatedStruct { };</p> <p>However, deprecating a struct/class doesn't create a warning for gcc versions <= 3.3 (haven't tried 3.4 yet). If you want to deprecate a class, also deprecate all member functions as well (which will cause warnings). </p> <p class="definition">Definition at line <a class="el" href="APIConfig_8h_source.html#l00088">88</a> of file <a class="el" href="APIConfig_8h_source.html">APIConfig.h</a>.</p> </div> </div> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="dir_c187b43c6f283d9fc95eff3f44ce072a.html">zypp</a></li><li class="navelem"><a class="el" href="APIConfig_8h.html">APIConfig.h</a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li> </ul> </div> </body> </html>