/usr/share/doc/libcpl-doc/html/struct__cpl__plugin__.html is in libcpl-doc 6.4.1-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 | <!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Common Pipeline Library Reference Manual: _cpl_plugin_ Struct 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="doxygen.css" rel="stylesheet" type="text/css" />
<link href="cpl.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 style="padding-left: 0.5em;">
<div id="projectname">Common Pipeline Library Reference Manual
 <span id="projectnumber">6.4.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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>Classes</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> |
<a href="struct__cpl__plugin__-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">_cpl_plugin_ Struct Reference<div class="ingroups"><a class="el" href="group__cpl__plugin.html">Plugin Interface</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>The type representation of the generic plugin interface.
<a href="struct__cpl__plugin__.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a0a2c1e2e44d8f3a0505fe96b1bf4ca6a"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__cpl__plugin__.html#a0a2c1e2e44d8f3a0505fe96b1bf4ca6a">api</a></td></tr>
<tr class="memdesc:a0a2c1e2e44d8f3a0505fe96b1bf4ca6a"><td class="mdescLeft"> </td><td class="mdescRight">The API version the Plugin complies to. <a href="#a0a2c1e2e44d8f3a0505fe96b1bf4ca6a"></a><br/></td></tr>
<tr class="separator:a0a2c1e2e44d8f3a0505fe96b1bf4ca6a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1b0c0cc4cc4a296a8fc5b8f4104f4b06"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__cpl__plugin__.html#a1b0c0cc4cc4a296a8fc5b8f4104f4b06">author</a></td></tr>
<tr class="memdesc:a1b0c0cc4cc4a296a8fc5b8f4104f4b06"><td class="mdescLeft"> </td><td class="mdescRight">Name of the plugin's author. <a href="#a1b0c0cc4cc4a296a8fc5b8f4104f4b06"></a><br/></td></tr>
<tr class="separator:a1b0c0cc4cc4a296a8fc5b8f4104f4b06"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a84ac0c13203840bf3bb6aece1a32da44"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__cpl__plugin__.html#a84ac0c13203840bf3bb6aece1a32da44">copyright</a></td></tr>
<tr class="memdesc:a84ac0c13203840bf3bb6aece1a32da44"><td class="mdescLeft"> </td><td class="mdescRight">Plugin's copyright. <a href="#a84ac0c13203840bf3bb6aece1a32da44"></a><br/></td></tr>
<tr class="separator:a84ac0c13203840bf3bb6aece1a32da44"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac10df7398cc0b9c0d2b629c3317551b8"><td class="memItemLeft" align="right" valign="top">cpl_plugin_func </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__cpl__plugin__.html#ac10df7398cc0b9c0d2b629c3317551b8">deinitialize</a></td></tr>
<tr class="memdesc:ac10df7398cc0b9c0d2b629c3317551b8"><td class="mdescLeft"> </td><td class="mdescRight">Deinitialization a plugin instance. <a href="#ac10df7398cc0b9c0d2b629c3317551b8"></a><br/></td></tr>
<tr class="separator:ac10df7398cc0b9c0d2b629c3317551b8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0f392cd13aede3e3071f2dd98fd87d5"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__cpl__plugin__.html#af0f392cd13aede3e3071f2dd98fd87d5">description</a></td></tr>
<tr class="memdesc:af0f392cd13aede3e3071f2dd98fd87d5"><td class="mdescLeft"> </td><td class="mdescRight">Plugin's detailed description. <a href="#af0f392cd13aede3e3071f2dd98fd87d5"></a><br/></td></tr>
<tr class="separator:af0f392cd13aede3e3071f2dd98fd87d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a908a52f88e83ff76202ff68625649cff"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__cpl__plugin__.html#a908a52f88e83ff76202ff68625649cff">email</a></td></tr>
<tr class="memdesc:a908a52f88e83ff76202ff68625649cff"><td class="mdescLeft"> </td><td class="mdescRight">Author's email address. <a href="#a908a52f88e83ff76202ff68625649cff"></a><br/></td></tr>
<tr class="separator:a908a52f88e83ff76202ff68625649cff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a609f914f455c448fcee26938696df624"><td class="memItemLeft" align="right" valign="top">cpl_plugin_func </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__cpl__plugin__.html#a609f914f455c448fcee26938696df624">execute</a></td></tr>
<tr class="memdesc:a609f914f455c448fcee26938696df624"><td class="mdescLeft"> </td><td class="mdescRight">Executes a plugin instance. <a href="#a609f914f455c448fcee26938696df624"></a><br/></td></tr>
<tr class="separator:a609f914f455c448fcee26938696df624"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab002ac0650e78b33f4dc59aff90fe361"><td class="memItemLeft" align="right" valign="top">cpl_plugin_func </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__cpl__plugin__.html#ab002ac0650e78b33f4dc59aff90fe361">initialize</a></td></tr>
<tr class="memdesc:ab002ac0650e78b33f4dc59aff90fe361"><td class="mdescLeft"> </td><td class="mdescRight">Initalizes a plugin instance. <a href="#ab002ac0650e78b33f4dc59aff90fe361"></a><br/></td></tr>
<tr class="separator:ab002ac0650e78b33f4dc59aff90fe361"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9cae15b2acdb2cbedddb18cead194d83"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__cpl__plugin__.html#a9cae15b2acdb2cbedddb18cead194d83">name</a></td></tr>
<tr class="memdesc:a9cae15b2acdb2cbedddb18cead194d83"><td class="mdescLeft"> </td><td class="mdescRight">Plugin's unique name. <a href="#a9cae15b2acdb2cbedddb18cead194d83"></a><br/></td></tr>
<tr class="separator:a9cae15b2acdb2cbedddb18cead194d83"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6cc2a56f06017eb64bd24006f423979"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__cpl__plugin__.html#ac6cc2a56f06017eb64bd24006f423979">synopsis</a></td></tr>
<tr class="memdesc:ac6cc2a56f06017eb64bd24006f423979"><td class="mdescLeft"> </td><td class="mdescRight">Plugin's short help string. <a href="#ac6cc2a56f06017eb64bd24006f423979"></a><br/></td></tr>
<tr class="separator:ac6cc2a56f06017eb64bd24006f423979"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3dbb9c233b5a03102452227d15ddd8df"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__cpl__plugin__.html#a3dbb9c233b5a03102452227d15ddd8df">type</a></td></tr>
<tr class="memdesc:a3dbb9c233b5a03102452227d15ddd8df"><td class="mdescLeft"> </td><td class="mdescRight">The Plugin type. <a href="#a3dbb9c233b5a03102452227d15ddd8df"></a><br/></td></tr>
<tr class="separator:a3dbb9c233b5a03102452227d15ddd8df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acb7b61553894cbdc842fa7a17cd45163"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="struct__cpl__plugin__.html#acb7b61553894cbdc842fa7a17cd45163">version</a></td></tr>
<tr class="memdesc:acb7b61553894cbdc842fa7a17cd45163"><td class="mdescLeft"> </td><td class="mdescRight">The Plugin version. <a href="#acb7b61553894cbdc842fa7a17cd45163"></a><br/></td></tr>
<tr class="separator:acb7b61553894cbdc842fa7a17cd45163"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The type representation of the generic plugin interface. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a0a2c1e2e44d8f3a0505fe96b1bf4ca6a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int _cpl_plugin_::api</td>
</tr>
</table>
</div><div class="memdoc">
<p>The API version the Plugin complies to. </p>
<p>The API version number identifies the internal layout of the plugin interface structure. It may be used by an application calling a plugin to setup the correct interface to communicate with the plugin or, in the simplest case, to ignore any plugin which does not match the plugin API an application has been buid for. </p>
</div>
</div>
<a class="anchor" id="a1b0c0cc4cc4a296a8fc5b8f4104f4b06"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* _cpl_plugin_::author</td>
</tr>
</table>
</div><div class="memdoc">
<p>Name of the plugin's author. </p>
<p>Variable contains the null-terminated identifier string of the plugins author. If the plugin does not specify an author this pointer should be set to a <code>NULL</code> pointer. </p>
</div>
</div>
<a class="anchor" id="a84ac0c13203840bf3bb6aece1a32da44"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* _cpl_plugin_::copyright</td>
</tr>
</table>
</div><div class="memdoc">
<p>Plugin's copyright. </p>
<p>Variable contains the copyright and license string applying to the plugin. The returned string must be null-terminated. If no copyright applies this pointer should be set to a <code>NULL</code> pointer. </p>
</div>
</div>
<a class="anchor" id="ac10df7398cc0b9c0d2b629c3317551b8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cpl_plugin_func _cpl_plugin_::deinitialize</td>
</tr>
</table>
</div><div class="memdoc">
<p>Deinitialization a plugin instance. </p>
<dl class="section return"><dt>Returns</dt><dd>The function must return 0 on success, and a non-zero value if the plugin deinitalization failed.</dd></dl>
<p>The function to deinitialize the plugin instance <em>plugin</em>. If this is <code>NULL</code> no deinitialization of the plugin instance is needed. </p>
</div>
</div>
<a class="anchor" id="af0f392cd13aede3e3071f2dd98fd87d5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* _cpl_plugin_::description</td>
</tr>
</table>
</div><div class="memdoc">
<p>Plugin's detailed description. </p>
<p>Variable contains the plugin's null-terminated detailed description string. The description is the detailed help for the plugin. For formatting the output the C special characters <code>'\n'</code>, <code>'\t'</code> maybe embedded in the returned string. If the plugin does not provide a detailed description the pointer should be set to a <code>NULL</code> pointer. </p>
</div>
</div>
<a class="anchor" id="a908a52f88e83ff76202ff68625649cff"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* _cpl_plugin_::email</td>
</tr>
</table>
</div><div class="memdoc">
<p>Author's email address. </p>
<p>Variable contains the null-terminated string of the author's email address. If the plugin does not specify an email address this pointer should be set to a <code>NULL</code> pointer. </p>
</div>
</div>
<a class="anchor" id="a609f914f455c448fcee26938696df624"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cpl_plugin_func _cpl_plugin_::execute</td>
</tr>
</table>
</div><div class="memdoc">
<p>Executes a plugin instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">plugin</td><td>The plugin to execute.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function must return 0 on success, and a non-zero value if the plugin execution failed.</dd></dl>
<p>The function executes the plugin instance <em>plugin</em>. </p>
</div>
</div>
<a class="anchor" id="ab002ac0650e78b33f4dc59aff90fe361"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">cpl_plugin_func _cpl_plugin_::initialize</td>
</tr>
</table>
</div><div class="memdoc">
<p>Initalizes a plugin instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">plugin</td><td>The plugin to instantiate.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The function must return 0 on success, and a non-zero value if the plugin instatiation failed.</dd></dl>
<p>The function to initialize a plugin instance. This maybe NULL if the initialization of the plugin is not needed. Otherwise it has to be called before plugin type specific members are accessed. </p>
</div>
</div>
<a class="anchor" id="a9cae15b2acdb2cbedddb18cead194d83"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* _cpl_plugin_::name</td>
</tr>
</table>
</div><div class="memdoc">
<p>Plugin's unique name. </p>
<p>Variable contains the unique name of the Plugin. To ensure uniqueness across all possible Plugins one should follow the hierarchical naming convention mentioned in the CPL documentation. </p>
</div>
</div>
<a class="anchor" id="ac6cc2a56f06017eb64bd24006f423979"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* _cpl_plugin_::synopsis</td>
</tr>
</table>
</div><div class="memdoc">
<p>Plugin's short help string. </p>
<p>Variable contains the plugin's null-terminated short help string. The short help string should summarize the plugin's purpose in not more than a few lines. It may contain new line characters. If the plugin does not provide a short help the pointer should be set to a <code>NULL</code> pointer. </p>
</div>
</div>
<a class="anchor" id="a3dbb9c233b5a03102452227d15ddd8df"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long _cpl_plugin_::type</td>
</tr>
</table>
</div><div class="memdoc">
<p>The Plugin type. </p>
<p>The Plugin type identifies the type of plugin. The data type is not a cpl_plugin_type in order to keep this interface as generic as possible. </p>
</div>
</div>
<a class="anchor" id="acb7b61553894cbdc842fa7a17cd45163"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long _cpl_plugin_::version</td>
</tr>
</table>
</div><div class="memdoc">
<p>The Plugin version. </p>
<p>The Plugin version number defines the version number for the plugin. The Plugin version number is an encoded version of the usual <b>MAJOR.MINOR.MICRO</b> form for version numbers. </p>
</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.2
</small></address>
</body>
</html>
|