FeatureErrorInfo

InstallShield 2014 » InstallScript Language Reference

Project: This information applies to the following project types:

InstallScript
InstallScript MSI

The FeatureErrorInfo function, which is called in the default code for the OnComponentError event handler, returns information about a file transfer error that does not generate any error event other than FeatureError—for example, FileLocked or SelfRegistrationError.

Note: This function returns information only about file transfer errors. For information about errors from script-created features, call FeatureError.

Syntax

FeatureErrorInfo ( );

Parameters

None

Return Values

A reference that can be assigned to a variable of type OBJECT by using the set keyword. Upon assignment, that variable (oErrorInfo in the following example) has the following properties:

FeatureErrorInfo Return Values

Property

Description

oErrorInfo.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 (oErrorInfo.Feature).

oErrorInfo.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 ("").

oErrorInfo.Feature.Name

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

oErrorInfo.Feature.Description

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

oErrorInfo.LastError

The numeric code for the file transfer error.

See Also