UnloadAddonLib

Description

Unloads an add-on library previously loaded by Softimage, allowing add-on developers to compile an add-on library while in use in Softimage. The following add-on library types can be unloaded: compiled operators, compiled custom commands, run-time shaders, events.

These add-on libraries can also be unloaded from the Libraries dialog located in the main menu under File > Addon > Libraries... Once you have unloaded an add-on library, the Softimage object connected to the library (for example, operators, shaders, etc... ) is no longer affected by the add-on until the library is loaded back. You don't need to reload the add-on explicitly since Softimage automatically reloads it when required. For instance, a compiled operator library is reloaded when an evaluation is required.

Scripting Syntax

    UnloadAddonLib( FileName )

Parameters

Parameter | Type | Description
FileName [in/out] | String | The full path of the library to unload. Default Value: A file browser prompts the user for a file if no filename is provided.

Examples

VBScript Example

    '
    ' This example demonstrates unloading an add-on library file
    '

    ' Unload an add-on library file located in the factory path
    myAddonLib = Application.InstallationPath( siFactoryPath ) & "\Addons\Application\bin\nt-x86\cpp_splatter.dll"
    Application.LogMessage "Unloading: " & myAddonLib
    UnloadAddonLib myAddonLib

    '---------------------------------------------------------
    ' Output from this script:
    'INFO : "Unloading: <FactoryPath>\Addons\Application\bin\nt-x86\cpp_splatter.dll"

See Also

UnloadAllAddonLibs | ReloadAddonLib | ReloadAllAddonLibs | UnloadAllCOMLibs

Autodesk Softimage v7.5