<!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"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>open-vm-tools 9.4.0: ToolsPluginData 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" />
</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">open-vm-tools 9.4.0
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">ToolsPluginData Struct Reference<div class="ingroups"><a class="el" href="group__vmtools__plugins.html">VMware Tools Plugins</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="plugin_8h_source.html">plugin.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a5b4dd922a4e2573a4ee6ffb178b99b08"><td class="memItemLeft" align="right" valign="top">char const * </td><td class="memItemRight" valign="bottom"><a class="el" href="structToolsPluginData.html#a5b4dd922a4e2573a4ee6ffb178b99b08">name</a></td></tr>
<tr class="separator:a5b4dd922a4e2573a4ee6ffb178b99b08"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad66898192cc649158116a5e5fa80faaf"><td class="memItemLeft" align="right" valign="top">GArray * </td><td class="memItemRight" valign="bottom"><a class="el" href="structToolsPluginData.html#ad66898192cc649158116a5e5fa80faaf">regs</a></td></tr>
<tr class="separator:ad66898192cc649158116a5e5fa80faaf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac35a7bf13c9ec30c2167b5e646f9f4ea"><td class="memItemLeft" align="right" valign="top">gboolean(* </td><td class="memItemRight" valign="bottom"><a class="el" href="structToolsPluginData.html#ac35a7bf13c9ec30c2167b5e646f9f4ea">errorCb</a> )(<a class="el" href="structToolsAppCtx.html">ToolsAppCtx</a> *ctx, <a class="el" href="group__vmtools__plugins.html#gaa58c4987a21e2bdbb4a7a6e28eb861a6">ToolsAppType</a> type, gpointer data, struct <a class="el" href="structToolsPluginData.html">ToolsPluginData</a> *plugin)</td></tr>
<tr class="separator:ac35a7bf13c9ec30c2167b5e646f9f4ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af37b971c4234260d72350af9a661a92c"><td class="memItemLeft" align="right" valign="top">gpointer </td><td class="memItemRight" valign="bottom"><a class="el" href="structToolsPluginData.html#af37b971c4234260d72350af9a661a92c">_private</a></td></tr>
<tr class="separator:af37b971c4234260d72350af9a661a92c"><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 registration data for an application. This gives the service information about all functionality exported by the application, and any events that the application may be interested in.</p>
<p>When the plugin is shut down, if the <em>regs</em> field is not NULL, it (and its element array) are freed with g_array_free().</p>
<p>Plugins shouldn't try to free the returned structure, since the container will try to use it even after the shutdown signal is sent to plugins. The pointer should either point to statically allocated memory, or be leaked (which should't be a problem since it will only be really leaked when the process is shutting down). </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="af37b971c4234260d72350af9a661a92c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gpointer ToolsPluginData::_private</td>
</tr>
</table>
</div><div class="memdoc">
<p>Private plugin data. </p>
</div>
</div>
<a class="anchor" id="ac35a7bf13c9ec30c2167b5e646f9f4ea"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">gboolean(* ToolsPluginData::errorCb)(<a class="el" href="structToolsAppCtx.html">ToolsAppCtx</a> *ctx, <a class="el" href="group__vmtools__plugins.html#gaa58c4987a21e2bdbb4a7a6e28eb861a6">ToolsAppType</a> type, gpointer data, struct <a class="el" href="structToolsPluginData.html">ToolsPluginData</a> *plugin)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Callback for registration errors. Whenever an entry provided in the <a class="el" href="structToolsPluginData.html#ad66898192cc649158116a5e5fa80faaf">regs</a> array fails to be registered, this function, if provided, will be called.</p>
<p>The plugin has two options when this callback fires:</p>
<p>. adjust its internal state so that the failed registration doesn't affect the normal operation of the other functions provided by the plugin, and return TRUE.</p>
<p>. return FALSE so that the container does not try to register any more features of the plugin.</p>
<p>Note that in either case, registrations that succeeded will not be reverted, so the plugin should still make sure that those still work, event if just in a "disabled" state. The plugin will not be unloaded when these errors happen.</p>
<p>Plugins can use the property of the <a class="el" href="structToolsPluginData.html#ad66898192cc649158116a5e5fa80faaf">regs</a> field that registration will happen in the order returned by the plugin's "on load" callback to have some control about what features to enable / disable.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">ctx</td><td>The application context. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Type of the app that failed to register. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>App-specific data that failed to register. If NULL, it means that no provider of the given type exists. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">plugin</td><td>The plugin's registration data.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>See above. TRUE to continue registration, FALSE to stop. </dd></dl>
</div>
</div>
<a class="anchor" id="a5b4dd922a4e2573a4ee6ffb178b99b08"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char const* ToolsPluginData::name</td>
</tr>
</table>
</div><div class="memdoc">
<p>Name of the application (required). </p>
</div>
</div>
<a class="anchor" id="ad66898192cc649158116a5e5fa80faaf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GArray* ToolsPluginData::regs</td>
</tr>
</table>
</div><div class="memdoc">
<p>List of features provided by the app. Registration of applications happens in the same order provided by this array. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>lib/include/vmware/tools/<a class="el" href="plugin_8h_source.html">plugin.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Nov 13 2013 17:04:41 for open-vm-tools 9.4.0 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
