Element: IniFileSearch

Description

Searches for file, directory or registry key and assigns to value of parent Property

Derived By

Restricting anyType

Attributes

Name	Type	Required?	Default	Description
Id	string	Yes		External key into the Signature table.
Field	integer	No		The field in the .ini line. If field is Null or 0, the entire line is read.
Key	string	Yes		The key value 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 file in 8.3 format.
Type	NMTOKEN (restriction)	No		Must be file if last child is FileSearch element and must be directory if last child is DirectorySearch element.

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		0..1
DirectorySearch	anyType (restriction)	1..1	Searches for directory and assigns to value of parent Property.
DirectorySearchRef	anyType (restriction)	1..1	References an existing DirectorySearch element.
FileSearch	anyType (restriction)	1..1	Searches for file and assigns to fullpath value of parent Property
FileSearchRef	anyType (restriction)	1..1	References an existing FileSearch element.

Definition

<xs:element name="IniFileSearch">
  <xs:annotation>
    <xs:appinfo>
      <xse:seeAlso ref="ComponentSearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />
      <xse:seeAlso ref="RegistrySearch" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />
      <xse:msiRef table="IniLocator" href="http://msdn.microsoft.com/library/aa369283.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />
      <xse:msiRef table="Signature" href="http://msdn.microsoft.com/library/aa371853.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />
    </xs:appinfo>
    <xs:documentation>Searches for file, directory or registry key and assigns to value of parent Property</xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:choice minOccurs="0">
      <xs:element ref="DirectorySearch" />
      <xs:element ref="DirectorySearchRef" />
      <xs:element ref="FileSearch" />
      <xs:element ref="FileSearchRef" />
    </xs:choice>
    <xs:attribute name="Id" use="required" type="xs:string">
      <xs:annotation>
        <xs:documentation>External key into the Signature table.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Field" type="xs:integer">
      <xs:annotation>
        <xs:documentation>The field in the .ini line. If field is Null or 0, the entire line is read.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Key" use="required" type="xs:string">
      <xs:annotation>
        <xs:documentation>The key value 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 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 file in 8.3 format.
                        This attribute should only be set if the user wants to manually specify the short name.
                    </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Type">
      <xs:annotation>
        <xs:documentation>Must be file if last child is FileSearch element and must be directory if last child is DirectorySearch element.</xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:NMTOKEN">
          <xs:enumeration value="directory">
            <xs:annotation>
              <xs:documentation>A directory location.</xs:documentation>
            </xs:annotation>
          </xs:enumeration>
          <xs:enumeration value="file">
            <xs:annotation>
              <xs:documentation>A file location.  This is the default value.</xs:documentation>
            </xs:annotation>
          </xs:enumeration>
          <xs:enumeration value="raw">
            <xs:annotation>
              <xs:documentation>A raw .ini value.</xs:documentation>
            </xs:annotation>
          </xs:enumeration>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
  </xs:complexType>
</xs:element>

---