XSIUtils.UnregisterSPDL

導入

v4.0

詳細

Softimage レジストリから SPDL ファイルを登録解除し、オプションで関連ファイルを削除します。

警告:これはローレベル API です。誤って使用すると Softimage のインストールに影響する可能性があるため、使用時には特に注意が必要です。

この関数は、XSIUtils.RegisterSPDLの呼び出しで実行されるインストールステップを前に戻します。一時オブジェクトに関連付けられているファイルをクリーンアップする場合に使用できます。

この関数は、"xsi -u"の呼び出しや、"Plugins(SPDL)"ダイアログの Uninstall 機能を使用する場合と同じです。このメソッドの呼び出しは、カスタムオブジェクトの SPDL ファイルに対してのみ行うことができます(CustomProperty など)。Softimage に付属の SPDL ファイルに対して呼び出すと、インストールに影響する可能性があります。

SPDL ファイルを登録解除すると、関連オブジェクトのインスタンスのカスタム PPGLayout が失われて、正しく動作しなくなります。

C#構文

XSIUtils.UnregisterSPDL( String in_SpdlFileName, Boolean in_bDeleteSPDL, Boolean in_bDeletePreset );

スクリプト構文

XSIUtils.UnregisterSPDL( SpdlFileName, [DeleteSPDL], [DeletePreset] );

パラメータ

パラメータ タイプ 説明
SpdlFileName String SPDL ファイルの名前。パスが含まれていない場合は、SPDL ファイルは[User Directory]¥Application¥spdl ディレクトリにあるものとみなされます。
DeleteSPDL Boolean SPDL ファイルを登録解除後に削除するかどうか。ファイルが読み取り専用の場合や、何らかの理由で削除できない場合には、メソッドは失敗します。この場合は、警告メッセージがログに記録されます。

デフォルト値: false

DeletePreset Boolean 関連プリセットファイルを削除するかどうか。このオプションでは、SPDL ファイルを基準として予想される場所にあるプリセットのみが削除されます(XSIUtils.RegisterSPDL を参照)。プリセットのコピーは削除されません。ファイルが読み取り専用の場合や、何らかの理由で削除できない場合には、メソッドは失敗します。この場合は、警告メッセージがログに記録されます。

デフォルト値: false

関連項目

XSIUtils.RegisterSPDL XSIUtils.WriteSPDL XSIUtils.Reload DataRepository.GetIdentifier SpdlCheck