Installer::CreateAdvertiseScript method

Article
03/22/2021

The CreateAdvertiseScript method of the Installer object generates an advertise script.

Syntax

.CreateAdvertiseScript(
  packagePath,
  scriptFilePath,
  transforms,
  language,
  platform,
  options
)

Parameters

packagePath

The full path to the Windows Installer package (.msi) to be advertised.

scriptFilePath

The full path to the script file to be created with the advertised information.

transforms

The list of transforms to apply to the product. Transforms in the list are delimited by semicolons. This parameter is optional.

language

The language of the installation package to use. This parameter is optional.

platform

This parameter specifies for which platform the installer should create the script. This parameter can be one of the following values.

Value	Meaning
msiAdvertiseCurrentPlatform 0	Creates a script for the current platform.
msiAdvertiseX86Platform 1	Creates a script for the x86 platform.
msiAdvertiseIA64Platform 2	Creates a script for Itanium-based systems.
msiAdvertiseX64Platform 4	Creates a script for the x64 platform.

options

Advertisement options. This parameter is optional. This parameter can be one of the following values. This parameter is optional.

Value	Meaning
msiAdvertiseDefault 0	Standard advertisement
msiAdvertiseSingleInstance 1	Advertises a new instance of the product. Requires that the first transform in the transform list of the transforms parameter be the instance transform that changes the product code. For more information, see Installing Multiple Instances of Products and Patches.

Return value

This method does not return a value.

Remarks

The AdvertiseProduct method uses the MsiAdvertiseProductEx function.

Examples

The following example demonstrates the use of the CreateAdvertiseScript method.

Dim installer
Set installer = CreateObject("WindowsInstaller.Installer")

'
' Create an advertise script for Orca
'

Installer.CreateAdvertiseScript "\\products\public\orca\orca.msi", "c:\scripts\orca.aas"

Requirements

Requirement	Value
Version	Windows Installer 5.0 on Windows Server 2012, Windows 8, Windows Server 2008 R2 or Windows 7. Windows Installer 4.0 or Windows Installer 4.5 on Windows Server 2008 or Windows Vista. Windows Installer 4.5 on Windows Server 2003 and Windows XP
DLL	Msi.dll
IID	IID_IInstaller is defined as 000C1090-0000-0000-C000-000000000046