SetStatusEx

InstallShield 2024 » InstallScript Language Reference

Project: This information applies to InstallScript projects.

The SetStatusEx function is called in an object script to set the object's status properties.

Syntax

SetStatusEx ( nNumber, szDescription, szSource, szScriptFile, nScriptLine, nScriptError );

Parameters

SetStatusEx Parameters

Parameter	Description
nNumber	Specifies the value of Status.Number.
szDescription	Specifies the value of Status.Description.
szSource	Specifies the value of Status.szSource.
szScriptFile	Specifies the value of Status.szScriptFile. To specify the current script file (that is, the script file that contains the call to SetStatusEx), pass the reserved identifier __FILE__.
nScriptLine	Specifies the value of Status.nScriptLine. To specify the current line number (that is, the line number of the call to SetStatusEx), pass the reserved identifier __LINE__.
nScriptError	Specifies the value of Status.nScriptError.

Return Values

SetStatusEx Return Values

Return Value	Description
>= ISERR_SUCCESS	The function successfully set the status properties.
< ISERR_SUCCESS	The function failed to set the status properties.