ISWiSetupFile Object

InstallShield 2018 » Automation Interface

Project • This information applies to the following project types:

Basic MSI
InstallScript
InstallScript MSI
InstallScript Object

ISWiSetupFile represents a support file in your project. The support file can be an existing one from the Support Files view (or the Support Files/Billboards view) in InstallShield or one that is added by calling AddSetupFile.

Use the project’s ISWiSetupFiles collection to access a specific support file. You must specify either an index number or the file key for the Item property of ISWiSetupFiles.

Members

ISWiSetupFile Object Members

Name

Type

Description

FileName

Read-Only Property

Gets the name of the support file (without the path).

Language

Read-Write Property

Gets the string that identifies the language identifier for the support file; for example:

m_pFile.Language = "1033"

Path

Read-Only Property

Gets the fully qualified path (including the file name) of the support file’s source location. Any path variables are resolved to the actual path.

Splash

Read-Write Property

Specifies whether this support file is a splash screen (True) or not (False).

Target

Read-Write Property

Gets or sets the support file’s target directory within SUPPORTDIR. The following line specifies the support file to be stored in the MyFolder1\MyFolder2 folder under SUPPORTDIR:

m_pFile.Target = "MyFolder1\MyFolder2"

Example

The file key is visible in the IDE only as the first entry in the Direct Editor view's ISSetupFile table. Instead of using the file key, you could write code similar to the following example to check for a certain file name:

    Dim pProj As ISWiProject

    Set pProj = CreateObject("IswiAutoAutomation Interface Version.ISWiProject")

    pProj.OpenProject "C:\MySetups\Project1.ism"

    Dim pSetupFile As ISWiSetupFile

    

    For Each pSetupFile In pProj.ISWiSetupFiles

        If UCase(pSetupFile.FileName) = "MYSUPPORTFILE.EXT" Then

            Exit For

        End If

    Next

 

    pProj.SaveProject

    pProj.CloseProject

If the file name MySupportFile.ext is found among the project’s setup files, the For loop ends, and pSetupFile holds a copy of the ISWiSetupFile object for MySupportFile.ext.