MsiSetProperty function

The MsiSetProperty function sets the value for an installation property.

Syntax


UINT MsiSetProperty(
  _In_  MSIHANDLE hInstall,
  _In_  LPCTSTR szName,
  _In_  LPCTSTR szValue
);

Parameters

hInstall [in]

Handle to the installation provided to a DLL custom action or obtained through MsiOpenPackage, MsiOpenPackageEx, or MsiOpenProduct.

szName [in]

Specifies the name of the property.

szValue [in]

Specifies the value of the property.

Return value

ERROR_FUNCTION_FAILED

The function failed.

ERROR_INVALID_HANDLE

An invalid or inactive handle was supplied.

ERROR_INVALID_PARAMETER

An invalid parameter was passed to the function.

ERROR_SUCCESS

The function succeeded.

Remarks

If the property is not defined, it is created by the MsiSetProperty function. If the value is null or an empty string, the property is removed.

Requirements

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 on Windows Server 2003 or Windows XP

Header

Msiquery.h

Library

Msi.lib

DLL

Msi.dll

Unicode and ANSI names

MsiSetPropertyW (Unicode) and MsiSetPropertyA (ANSI)

See also

Installer State Access Functions

 

 

Community Additions

ADD
Show:
© 2014 Microsoft