| <!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.18"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Celix: libs/framework/include/celix_bundle.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="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.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 id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Celix |
|  <span id="projectnumber">2.2.1</span> |
| </div> |
| <div id="projectbrief">An implementation of the OSGi specification adapted to C and C++</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.18 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <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('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_6719ab1f1f7655efc2fa43f7eb574fd1.html">libs</a></li><li class="navelem"><a class="el" href="dir_edbb2ffdc3e165978e68de3a46f2e8a0.html">framework</a></li><li class="navelem"><a class="el" href="dir_bc286dd6b945a73064974dfd7e40f558.html">include</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#func-members">Functions</a> </div> |
| <div class="headertitle"> |
| <div class="title">celix_bundle.h File Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="textblock"><code>#include "celix_types.h"</code><br /> |
| <code>#include "bundle_state.h"</code><br /> |
| </div><div class="textblock"><div class="dynheader"> |
| Include dependency graph for celix_bundle.h:</div> |
| <div class="dyncontent"> |
| <div class="center"><img src="celix__bundle_8h__incl.png" border="0" usemap="#libs_2framework_2include_2celix__bundle_8h" alt=""/></div> |
| <map name="libs_2framework_2include_2celix__bundle_8h" id="libs_2framework_2include_2celix__bundle_8h"> |
| <area shape="rect" title=" " alt="" coords="42,5,193,47"/> |
| <area shape="rect" title=" " alt="" coords="5,95,104,121"/> |
| <area shape="rect" title=" " alt="" coords="128,95,235,121"/> |
| </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="celix__bundle_8h__dep__incl.png" border="0" usemap="#libs_2framework_2include_2celix__bundle_8hdep" alt=""/></div> |
| <map name="libs_2framework_2include_2celix__bundle_8hdep" id="libs_2framework_2include_2celix__bundle_8hdep"> |
| <area shape="rect" title=" " alt="" coords="5,5,156,47"/> |
| <area shape="rect" href="celix__api_8h.html" title=" " alt="" coords="5,95,156,136"/> |
| </map> |
| </div> |
| </div> |
| <p><a href="celix__bundle_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="func-members"></a> |
| Functions</h2></td></tr> |
| <tr class="memitem:a8a9b02c9438f05099ff2bde9fea8c3cd"><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="celix__bundle_8h.html#a8a9b02c9438f05099ff2bde9fea8c3cd">celix_bundle_getId</a> (const celix_bundle_t *bnd)</td></tr> |
| <tr class="separator:a8a9b02c9438f05099ff2bde9fea8c3cd"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a7106fcc7b06c0506dd7e1678ba024a35"><td class="memItemLeft" align="right" valign="top">celix_bundle_state_e </td><td class="memItemRight" valign="bottom"><a class="el" href="celix__bundle_8h.html#a7106fcc7b06c0506dd7e1678ba024a35">celix_bundle_getState</a> (const celix_bundle_t *bnd)</td></tr> |
| <tr class="separator:a7106fcc7b06c0506dd7e1678ba024a35"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5cbe24596271fc91c79c8f42c8b92bc5"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="celix__bundle_8h.html#a5cbe24596271fc91c79c8f42c8b92bc5">celix_bundle_getEntry</a> (const celix_bundle_t *bnd, const char *path)</td></tr> |
| <tr class="separator:a5cbe24596271fc91c79c8f42c8b92bc5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5abd44b1259599d08f2312760fb32170"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="celix__bundle_8h.html#a5abd44b1259599d08f2312760fb32170">celix_bundle_getGroup</a> (const celix_bundle_t *bnd)</td></tr> |
| <tr class="separator:a5abd44b1259599d08f2312760fb32170"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a391c2aa2fdf3c8d0c65fc07a07bb7545"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="celix__bundle_8h.html#a391c2aa2fdf3c8d0c65fc07a07bb7545">celix_bundle_getSymbolicName</a> (const celix_bundle_t *bnd)</td></tr> |
| <tr class="separator:a391c2aa2fdf3c8d0c65fc07a07bb7545"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Function Documentation</h2> |
| <a id="a5cbe24596271fc91c79c8f42c8b92bc5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5cbe24596271fc91c79c8f42c8b92bc5">◆ </a></span>celix_bundle_getEntry()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">char* celix_bundle_getEntry </td> |
| <td>(</td> |
| <td class="paramtype">const celix_bundle_t * </td> |
| <td class="paramname"><em>bnd</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>path</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Returns a the use-able entry path for the provided relative path to a bundle resource.</p> |
| <p>For example if there is a resource entry in the bundle at path 'META-INF/descriptors/foo.descriptor` this call will return a absolute or relative path to the extracted location of the bundle resource, e.g.: .cache/bundle5/version0.0/META-INF/descriptors/foo.descriptor</p> |
| <p>The caller is responsible for freeing the returned path entry. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">bnd</td><td>The bundle </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A use-able path to the bundle resource entry of NULL if the entry is not found. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a5abd44b1259599d08f2312760fb32170"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a5abd44b1259599d08f2312760fb32170">◆ </a></span>celix_bundle_getGroup()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const char* celix_bundle_getGroup </td> |
| <td>(</td> |
| <td class="paramtype">const celix_bundle_t * </td> |
| <td class="paramname"><em>bnd</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <a id="a8a9b02c9438f05099ff2bde9fea8c3cd"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8a9b02c9438f05099ff2bde9fea8c3cd">◆ </a></span>celix_bundle_getId()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">long celix_bundle_getId </td> |
| <td>(</td> |
| <td class="paramtype">const celix_bundle_t * </td> |
| <td class="paramname"><em>bnd</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Returns the bundle id. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">bnd</td><td>The bundle </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The bundle id or < 0 if something went wrong. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a7106fcc7b06c0506dd7e1678ba024a35"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a7106fcc7b06c0506dd7e1678ba024a35">◆ </a></span>celix_bundle_getState()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">celix_bundle_state_e celix_bundle_getState </td> |
| <td>(</td> |
| <td class="paramtype">const celix_bundle_t * </td> |
| <td class="paramname"><em>bnd</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| <p>Returns the bundle state. </p><dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">bnd</td><td>The bundle </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>The bundle state or OSGI_FRAMEWORK_BUNDLE_UNKNOWN if something went wrong. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a391c2aa2fdf3c8d0c65fc07a07bb7545"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a391c2aa2fdf3c8d0c65fc07a07bb7545">◆ </a></span>celix_bundle_getSymbolicName()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const char* celix_bundle_getSymbolicName </td> |
| <td>(</td> |
| <td class="paramtype">const celix_bundle_t * </td> |
| <td class="paramname"><em>bnd</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| </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.18 |
| </small></address> |
| </body> |
| </html> |
