Reload


Description

Reload is called when the plug-in is reloaded into the cache.

A plug-in is unloaded from the cache when a user right-clicks a plug-in in the plug-in tree and clears the Cached check. This unloads the plug-in (the .dll/.so file, or the script file) from memory, but does not "unload" the plug-in from Softimage. The Plugin and PluginItem objects still exist in Softimage, and the plug-in is still registered.

When a plug-in is not cached, it is loaded and unloaded every time a plug-in item (such as a command) is invoked. This triggers the Reload and Unload callbacks.


Applies To

All plug-in items except Custom Properties.


Syntax

public class <plugin-item_name>

{

	public bool Reload( Context in_context )

	{

		...

	}

}
CStatus <plugin-item_name>_Reload( CRef& in_context ) 

{ 

	... 

}
function <plugin-item_name>_Reload( in_context ) 

{ 

	... 

}
def <plugin-item_name>_Reload( in_context ):

	...
Function <plugin-item_name>_Reload( in_context )

	...

End Function
sub <plugin-item_name>_Reload 

{ 

	my $in_context = shift; 

}

<plugin-item-name> is the name used to register the plug-in item in XSILoadPlugin, with any spaces converted to underscores.


Parameters

Parameter Language Type Description
in_context Scripting and C# Context Context.Source returns the plug-in item.
C++ CRef& A reference to the Context object.


See Also