InstallShield 2019 » InstallScript Language Reference
Project • This information applies to InstallScript projects.
LogWriteCustomNumber writes the number specified by nValue to the log file in the custom logging section under the key name specified by szKey.
Syntax
LogWriteCustomNumber( szKey, nValue );
Parameters
|
Parameter |
Description |
|
szKey |
Specifies the key name that identifies the number being written to the log file. All key names written to a particular log file must be unique, regardless of whether they are written with LogWriteCustomNumber or LogWriteCustomString. If you specify a key name that already exists in the custom logging section, its value is overwritten. |
|
nValue |
Specifies the number to be written to the log file. |
Return Values
|
Return Value |
Description |
|
>= ISERR_SUCCESS |
Indicates that the function successfully wrote the number to the log file. |
|
< ISERR_SUCCESS |
Indicates that the function was unable to write the number to the log file. |
Additional Information
LogWriteCustomNumber fails if you call it while logging is disabled.
Custom log file entries do not affect maintenance or uninstallation of the product unless you add code to the script to read custom values and perform actions based on those values. LogWriteCustomNumber cannot write data to the maintenance/uninstallation section of the log file (that is, the section where the installation automatically writes data, such as the files that are installed and the registry entries that are created, and from which it automatically reads data during maintenance or uninstallation).
To execute script code only when the product is being completely uninstalled, use an if-then statement:
if REMOVEALLMODE!=0 then
/* this code is executed only during uninstallation */
endif;
To perform specific uninstallation actions when a particular feature is uninstalled, override the feature’s UnInstalling event with the appropriate code.
See Also
InstallScript Functions that Are Logged for Uninstallation
InstallShield 2019 Help LibraryApril 2019 |
Copyright Information | Flexera |