SprintfMsiLog

InstallShield 2024 » InstallScript Language Reference

Project: This information applies to the following project types:

Basic MSI
InstallScript MSI

The SprintfMsiLog function writes a message directly to the Windows Installer log file.

Syntax

SprintfMsiLog ( szFormat [,arg] [,...] );

Parameters

SprintfMsiLog Parameters

Parameter

Description

szFormat

Specifies a string than can include literal text and must include one format specifier for each argument to be embedded in the string returned by svResult.

arg

You can specify up to nine arguments to be included in the message. You must have one argument for each format specifier in the message. The type of each argument must match the type of its respective format specifier.

SprintfMsiLog generates a compiler error or fail at run time under the following conditions:

More than nine format specifiers and arguments are specified. This results in a compiler error.
The number of arguments does not match the number of format specifiers. When a specifier does not have a corresponding argument, the resulting string contains unpredictable characters in the specifier's position. When there are more arguments than specifiers, the excess arguments are not inserted into the resulting string.
A variable does not match the type of its respective format specifier. The resulting string contains unpredictable characters in the specifier's position.

Return Values

There are no return values for this function. If the function is successful, the values are written to the Windows Installer log file. If the function fails, the values are not written to the Windows Installer log file.