Object Model: PluginRegistrar.UserData

PluginRegistrar.UserData

Introduced

v8.0 (2010)

Description

Sets or returns Variant data inside the Plugin object being registered. Softimage does not care about the content or meaning of the data. You can store a wide variety of data, including simple types, Arrays and object references. This API is convenient when you need to access the plug-in data from the XSILoadPlugin and XSIUnloadPlugin callbacks.

Once added the data remains active as long as Softimage is running or until you manually unload the plug-in. The user data is not persisted. See Plugin.UserData for more details.

C# Syntax

// get accessor
Object rtn = PluginRegistrar.UserData;
// set accessor
PluginRegistrar.UserData = Object;