LogReadCustomNumber
InstallShield 2024 » InstallScript Language Reference
Project:
The LogReadCustomNumber function reads the number that is stored the log file’s custom logging section under the key name specified by szKey, and it returns the number data in nvValue.
Syntax
LogReadCustomNumber( szKey, nvValue );
Parameters
|
Parameter |
Description |
|
szKey |
Specifies the key name that identifies the number being read from the log file. |
|
nvValue |
Returns the number data that is read from the log file. |
Return Values
|
Return Value |
Description |
|
>= ISERR_SUCCESS |
Indicates that the function successfully read the number from the log file. |
|
< ISERR_SUCCESS |
Indicates that the function was unable to read the number from the log file. |
Additional Information
LogReadCustomNumber is not affected by whether logging is enabled or disabled. LogReadCustomNumber can read values that were entered with LogWriteCustomNumber and numbers that were entered as strings (for example, "123") with LogWriteCustomString. LogReadCustomNumber fails if used to read non-numeric data (for example, "123abc").
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. LogReadCustomString cannot read data from 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