Element: IniFile

Description

Adds or removes .ini file entries.

Derived By

Restricting anyType

Attributes

Name	Type	Required?	Default	Description
Id	string	Yes		Identifier for ini file.
Action	NMTOKEN (restriction)	Yes		The type of modification to be made.
Directory	string	No		Name of a property, the value of which is the full path of the folder containing the .ini file.
Key	string	Yes		The localizable .ini file key within the section.
LongName	LongFileNameType	No
Name	LongFileNameType	Yes		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.
Section	string	Yes		The localizable .ini file section.
ShortName	ShortFileNameType	No		The short name of the in 8.3 format.
Value	string	No		The localizable value to be written or deleted. This attribute must be set if the Action attribute's value is "addLine", "addTag", or "createLine".

Content Model

Always empty.

Referenced By

• Element Component

Definition

<xs:element name="IniFile">
  <xs:annotation>
    <xs:documentation>
                Adds or removes .ini file entries.
            </xs:documentation>
    <xs:appinfo>
      <xse:msiRef table="IniFile" href="http://msdn.microsoft.com/library/aa369282.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />
      <xse:msiRef table="RemoveIniFile" href="http://msdn.microsoft.com/library/aa371204.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />
    </xs:appinfo>
  </xs:annotation>
  <xs:complexType>
    <xs:attribute name="Id" use="required" type="xs:string">
      <xs:annotation>
        <xs:documentation>Identifier for ini file.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Action" use="required">
      <xs:annotation>
        <xs:documentation>The type of modification to be made.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:NMTOKEN">
          <xs:enumeration value="addLine">
            <xs:annotation>
              <xs:documentation>Creates or updates an .ini entry.</xs:documentation>
            </xs:annotation>
          </xs:enumeration>
          <xs:enumeration value="addTag">
            <xs:annotation>
              <xs:documentation>Creates a new entry or appends a new comma-separated value to an existing entry.</xs:documentation>
            </xs:annotation>
          </xs:enumeration>
          <xs:enumeration value="createLine">
            <xs:annotation>
              <xs:documentation>Creates an .ini entry only if the entry does no already exist.</xs:documentation>
            </xs:annotation>
          </xs:enumeration>
          <xs:enumeration value="removeLine">
            <xs:annotation>
              <xs:documentation>Removes an .ini entry.</xs:documentation>
            </xs:annotation>
          </xs:enumeration>
          <xs:enumeration value="removeTag">
            <xs:annotation>
              <xs:documentation>Removes a tag from an .ini entry.</xs:documentation>
            </xs:annotation>
          </xs:enumeration>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="Directory" type="xs:string">
      <xs:annotation>
        <xs:documentation>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.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Key" use="required" type="xs:string">
      <xs:annotation>
        <xs:documentation>The localizable .ini file key within the section.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="LongName" type="LongFileNameType">
      <xs:annotation>
        <xs:appinfo>
          <xse:deprecated ref="Name" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />
        </xs:appinfo>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Name" type="LongFileNameType" use="required">
      <xs:annotation>
        <xs:documentation>
                        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.
                    </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Section" use="required" type="xs:string">
      <xs:annotation>
        <xs:documentation>The localizable .ini file section.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="ShortName" type="ShortFileNameType">
      <xs:annotation>
        <xs:documentation>
                        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.
                    </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Value" type="xs:string">
      <xs:annotation>
        <xs:documentation>
                        The localizable value to be written or deleted.  This attribute must be set if
                        the Action attribute's value is "addLine", "addTag", or "createLine".
                    </xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>
</xs:element>

---