service/protocol-plugin/lib/cpluff/doc/reference/c-api/structcp__plugin__import__t.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   3 <title>C-Pluff C API: cp_plugin_import_t Struct Reference</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.1 -->
   8 <div class="tabs">
   9   <ul>
  10     <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  11     <li><a href="modules.html"><span>Modules</span></a></li>
  12     <li id="current"><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  13     <li><a href="files.html"><span>Files</span></a></li>
  14     <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  15   </ul></div>
  16 <div class="tabs">
  17   <ul>
  18     <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
  19     <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
  20   </ul></div>
  21 <h1>cp_plugin_import_t Struct Reference<br>
  22 <small>
  23 [<a class="el" href="group__cStructs.html">Data structures</a>]</small>
  24 </h1><!-- doxytag: class="cp_plugin_import_t" --><hr><a name="_details"></a><h2>Detailed Description</h2>
  25 Information about plug-in import.
  26 <p>
  27 Plug-in import structures are contained in <a class="el" href="structcp__plugin__info__t.html#e03a6d473f95a77ad6de9d43610f8d39">cp_plugin_info_t::imports</a>.
  28 <p>
  29 <table border="0" cellpadding="0" cellspacing="0">
  30 <tr><td></td></tr>
  31 <tr><td colspan="2"><br><h2>Data Fields</h2></td></tr>
  32 <tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__plugin__import__t.html#29da905aeb4da90dae48b2aa19f5cc62">plugin_id</a></td></tr>
  33
  34 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The identifier of the imported plug-in.  <a href="#29da905aeb4da90dae48b2aa19f5cc62"></a><br></td></tr>
  35 <tr><td class="memItemLeft" nowrap align="right" valign="top">char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__plugin__import__t.html#56abfaab87c46691c1ef3ad0df23e864">version</a></td></tr>
  36
  37 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">An optional version requirement.  <a href="#56abfaab87c46691c1ef3ad0df23e864"></a><br></td></tr>
  38 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcp__plugin__import__t.html#69b1249c974e922ecdd066c43dc91f88">optional</a></td></tr>
  39
  40 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Is this import optional.  <a href="#69b1249c974e922ecdd066c43dc91f88"></a><br></td></tr>
  41 </table>
  42 <hr><h2>Field Documentation</h2>
  43 <a class="anchor" name="29da905aeb4da90dae48b2aa19f5cc62"></a><!-- doxytag: member="cp_plugin_import_t::plugin_id" ref="29da905aeb4da90dae48b2aa19f5cc62" args="" -->
  44 <div class="memitem">
  45 <div class="memproto">
  46       <table class="memname">
  47         <tr>
  48           <td class="memname">char* <a class="el" href="structcp__plugin__import__t.html#29da905aeb4da90dae48b2aa19f5cc62">plugin_id</a>          </td>
  49         </tr>
  50       </table>
  51 </div>
  52 <div class="memdoc">
  53
  54 <p>
  55 The identifier of the imported plug-in.
  56 <p>
  57 This corresponds to the <em>plugin</em> attribute of the <em>import</em> element in a plug-in descriptor.
  58 </div>
  59 </div><p>
  60 <a class="anchor" name="56abfaab87c46691c1ef3ad0df23e864"></a><!-- doxytag: member="cp_plugin_import_t::version" ref="56abfaab87c46691c1ef3ad0df23e864" args="" -->
  61 <div class="memitem">
  62 <div class="memproto">
  63       <table class="memname">
  64         <tr>
  65           <td class="memname">char* <a class="el" href="structcp__plugin__import__t.html#56abfaab87c46691c1ef3ad0df23e864">version</a>          </td>
  66         </tr>
  67       </table>
  68 </div>
  69 <div class="memdoc">
  70
  71 <p>
  72 An optional version requirement.
  73 <p>
  74 NULL if no version requirement. This is the version of the imported plug-in the importing plug-in was compiled against. Any version of the imported plug-in that is backwards compatible with this version fulfills the requirement. This corresponds to the <em>if-version</em> attribute of the <em>import</em> element in a plug-in descriptor.
  75 </div>
  76 </div><p>
  77 <a class="anchor" name="69b1249c974e922ecdd066c43dc91f88"></a><!-- doxytag: member="cp_plugin_import_t::optional" ref="69b1249c974e922ecdd066c43dc91f88" args="" -->
  78 <div class="memitem">
  79 <div class="memproto">
  80       <table class="memname">
  81         <tr>
  82           <td class="memname">int <a class="el" href="structcp__plugin__import__t.html#69b1249c974e922ecdd066c43dc91f88">optional</a>          </td>
  83         </tr>
  84       </table>
  85 </div>
  86 <div class="memdoc">
  87
  88 <p>
  89 Is this import optional.
  90 <p>
  91 1 for optional and 0 for mandatory import. An optional import causes the imported plug-in to be started if it is available but does not stop the importing plug-in from starting if the imported plug-in is not available. If the imported plug-in is available but the API version conflicts with the API version requirement then the importing plug-in fails to start. This corresponds to the <em>optional</em> attribute of the <em>import</em> element in a plug-in descriptor.
  92 </div>
  93 </div><p>
  94 <hr>The documentation for this struct was generated from the following file:<ul>
  95 <li><a class="el" href="cpluff_8h-source.html">cpluff.h</a></ul>
  96 <hr size="1">
  97 <p class="footer">
  98 <a href="http://www.c-pluff.org/">C-Pluff</a>, a plug-in framework for C<br>
  99 Copyright 2007 <a href="http://www.jlehtinen.net/">Johannes Lehtinen</a>
 100 </p>
 101 <p class="generated-by">
 102 Generated on Fri Apr 6 15:40:57 2007 for C-Pluff C API by&nbsp;<a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.1
 103 </p>
 104 </body>
 105 </html>