OnComponentError

InstallShield 2016 » InstallScript Language Reference

Project • This information applies to the following project types:

InstallScript
InstallScript MSI

The OnComponentError event handler responds to the ComponentError event that is generated when the installation encounters a general file-transfer error.

The default OnComponentError implementation uses properties of an ErrorInfo object that is declared in OnComponentError and assigned a value by the following statement:

        set ErrorInfo = ComponentErrorInfo( );

OnComponentError Parameters

Property

Description

ErrorInfo.Feature

An object whose properties provide information about the feature that was being transferred when the error occurred. If the error is not associated with a particular feature, or the feature cannot be identified, this property is not set; test for this case by checking the value of IsObject(ErrorInfo.Feature).

ErrorInfo.Feature.Description

A string describing the file transfer error. This string may be null ("").

ErrorInfo.Feature.DisplayName

The display name of the feature that was being transferred when the error occurred. If you did not specify a display name for this feature, this string is null ("").

ErrorInfo.Feature.Name

The name of the feature that was being transferred when the error occurred.

ErrorInfo.FileError.Description

A string-formatted description of ErrorInfo.LastError.

ErrorInfo.FileError.File

For a file-related error: The path and name of the file that encountered an error while the installation attempted to transfer it.

ErrorInfo.FileGroup

The name of the component that is being transferred when the error occurs.

ErrorInfo.LastError

The numeric code for the file-transfer error.