service/protocol-plugin/lib/cpluff/doc/reference/c-api/group__cTypedefsOpaque.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: Opaque types</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><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 <h1>Opaque types<br>
  17 <small>
  18 [<a class="el" href="group__cTypedefs.html">Typedefs</a>]</small>
  19 </h1><hr><a name="_details"></a><h2>Detailed Description</h2>
  20 Opaque data type definitions.
  21 <p>
  22
  23 <p>
  24 <table border="0" cellpadding="0" cellspacing="0">
  25 <tr><td></td></tr>
  26 <tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
  27 <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="group__cTypedefsOpaque.html#gcb1aa0619dcefa746383c5e0833b62e7">cp_context_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cTypedefsOpaque.html#gcb1aa0619dcefa746383c5e0833b62e7">cp_context_t</a></td></tr>
  28
  29 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A plug-in context represents the co-operation environment of a set of plug-ins from the perspective of a particular participating plug-in or the perspective of the main program.  <a href="#gcb1aa0619dcefa746383c5e0833b62e7"></a><br></td></tr>
  30 </table>
  31 <hr><h2>Typedef Documentation</h2>
  32 <a class="anchor" name="gcb1aa0619dcefa746383c5e0833b62e7"></a><!-- doxytag: member="cpluff.h::cp_context_t" ref="gcb1aa0619dcefa746383c5e0833b62e7" args="" -->
  33 <div class="memitem">
  34 <div class="memproto">
  35       <table class="memname">
  36         <tr>
  37           <td class="memname">typedef struct <a class="el" href="group__cTypedefsOpaque.html#gcb1aa0619dcefa746383c5e0833b62e7">cp_context_t</a> <a class="el" href="group__cTypedefsOpaque.html#gcb1aa0619dcefa746383c5e0833b62e7">cp_context_t</a>          </td>
  38         </tr>
  39       </table>
  40 </div>
  41 <div class="memdoc">
  42
  43 <p>
  44 A plug-in context represents the co-operation environment of a set of plug-ins from the perspective of a particular participating plug-in or the perspective of the main program.
  45 <p>
  46 It is used as an opaque handle to the shared resources but the framework also uses the context to identify the plug-in or the main program invoking framework functions. Therefore a plug-in should not generally expose its context instance to other plug-ins or the main program and neither should the main program expose its context instance to plug-ins. The main program creates plug-in contexts using <a class="el" href="group__cFuncsContext.html#g7d239c4fc07cf7d3095a20900444ad62">cp_create_context</a> and plug-ins receive their plug-in contexts via <a class="el" href="structcp__plugin__runtime__t.html#f193bb8481e4b6aeab275fa5908a9af9">cp_plugin_runtime_t::create</a>.
  47 </div>
  48 </div><p>
  49 <hr size="1">
  50 <p class="footer">
  51 <a href="http://www.c-pluff.org/">C-Pluff</a>, a plug-in framework for C<br>
  52 Copyright 2007 <a href="http://www.jlehtinen.net/">Johannes Lehtinen</a>
  53 </p>
  54 <p class="generated-by">
  55 Generated on Fri Apr 6 15:40:55 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
  56 </p>
  57 </body>
  58 </html>