v4.0
Unregisters a SPDL file from the Softimage registry and
optionally erases the associated files.
WARNING: This is a low-level API and should be used with extreme
caution because incorrect usage can damage the Softimage
installation.
This function reverses the installation steps performed by a call
to XSIUtils.RegisterSPDL.
It can be used to clean up files associated with a temporary
object.
This function is equivalent to calling "xsi -u" or using the
Uninstall feature on the "Plugins(SPDL)" dialog. This method should
only be called on SPDL files for custom objects, for example
CustomProperty. If called on one
of the SPDL files that gets shipped with Softimage it could damage
the installation.
Once the SPDL file is unregistered any instances of the associated
object will lose their custom PPGLayout and may not operate properly.
XSIUtils.UnregisterSPDL( SpdlFileName, [DeleteSPDL], [DeletePreset] ); |
Parameter | Type | Description |
---|---|---|
SpdlFileName | String | Name of the SPDL file. If no path is included then Softimage expects the SPDL file to be in the [User Directory]\Application\spdl directory. |
DeleteSPDL | Boolean | Whether to delete the SPDL file after it has been unregistered.
If the file is read-only or cannot be deleted for some other reason
the method will not fail, but a warning message will be logged.
Default Value: false |
DeletePreset | Boolean | Whether to delete the associated Preset file. This option will
only erase the Preset from the expected location relative to the
SPDL file. (See XSIUtils.RegisterSPDL). Any copies
of the Preset will remain. If the file is read-only or cannot be
deleted for some other reason the method will not fail, but a
warning message will be logged.
Default Value: false |