Installer::AdvertiseProduct method

Article
03/22/2021

The AdvertiseProduct method of the Installer object advertises an installation package.

Syntax

.AdvertiseProduct(
  packagePath,
  context,
  transforms,
  language,
  options
)

Parameters

packagePath

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

context

The context of the advertisement. This parameter can be one of the following values.

Value	Meaning
msiAdvertiseProductMachine 0	Advertises the application for an instalation in the per-machine installation context. This makes the package available for installation by all users of the computer.
msiAdvertiseProductUser 1	Advertises the application for an installation in the per-user installation context.

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.

options

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

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 AdvertiseProduct method.

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

'
' Perform machine advertisement of package, use transform
'

Installer.AdvertiseProduct "c:\scratch\simpletst\rtm\simple.msi", 0, "c:\scratch\simpletst\rtm\transform.mst"

'
' Verify advertised product state and registration
'
 
MsgBox Installer.ProductState("{BAE98781-CF88-4309-8E2D-3D8B347F5B53}")
MsgBox Installer.ProductInfo("{BAE98781-CF88-4309-8E2D-3D8B347F5B53}", "Transforms")

'
' Remove Product
'
Installer.InstallProduct "c:\scratch\simpletst\rtm\simple.msi", "REMOVE=ALL"

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