carbOnPluginRegister#

void carbOnPluginRegister( carb::Framework *framework, carb::PluginRegistryEntry *outEntry, )#

An automatically-generated function exported by some Carbonite plugins (now deprecated).

The type of this function is carb::OnPluginRegisterFn and named kCarbOnPluginRegisterFnName.

Only plugins built with Framework versions prior to 0.5 export this function.

Note

This function is automatically generated in some older plugins by the CARB_PLUGIN_IMPL macro. It may be called by the Framework when registering a plugin. This serves as documentation of this function only.

Warning

This function has been superseded by carbOnPluginRegisterEx and carbOnPluginRegisterEx2 in Framework version 0.5. The Framework will look for and call the first available function from the following list: carbOnPluginRegisterEx2, carbOnPluginRegisterEx, carbOnPluginRegister (this function).

Parameters:

framework – The Framework will pass this function a pointer to itself when calling.
outEntry – The plugin will populate this structure to inform the Framework about itself.