IniFile Element

Windows Installer XML (WiX) v3.0

IniFile Element

Description
Adds or removes .ini file entries.
Windows Installer references
IniFile Table, RemoveIniFile Table
Parents
Component
Inner Text
None
Children
None
Attributes
Name Type Description Required
Id String Identifier for ini file. Yes
Action Enumeration The type of modification to be made. This attribute's value must be one of the following:
addLine
Creates or updates an .ini entry.
addTag
Creates a new entry or appends a new comma-separated value to an existing entry.
createLine
Creates an .ini entry only if the entry does no already exist.
removeLine
Removes an .ini entry.
removeTag
Removes a tag from an .ini entry.
Yes
Directory String Name of a property, the value of which is the full path of the folder containing the .ini file. Can be name of a directory in the Directory table, a property set by the AppSearch table, or any other property representing a full path.  
Key String The localizable .ini file key within the section. Yes
LongName LongFileNameType This attribute has been deprecated; please use the Name attribute instead.  
Name LongFileNameType In prior versions of the WiX toolset, this attribute specified the short name. This attribute's value may now be either a short or long name. If a short name is specified, the ShortName attribute may not be specified. If a long name is specified, the LongName attribute may not be specified. Also, if this value is a long name, the ShortName attribute may be omitted to allow WiX to attempt to generate a unique short name. However, if this name collides with another file or you wish to manually specify the short name, then the ShortName attribute may be specified. Yes
Section String The localizable .ini file section. Yes
ShortName ShortFileNameType The short name of the in 8.3 format. This attribute should only be set if there is a conflict between generated short names or the user wants to manually specify the short name.  
Value String The localizable value to be written or deleted. This attribute must be set if the Action attribute's value is "addLine", "addTag", or "createLine".  
See Also
Wix Schema