GetObjectByIndex

InstallShield 2024 » InstallScript Language Reference

Project: This information applies to InstallScript projects.

The GetObjectByIndex function finds the setup's or object's subobject that is specified by nIndex and returns a reference that can be assigned to a variable of type OBJECT by using the set keyword.

Syntax

GetObjectByIndex ( nIndex );

Parameters

GetObjectByIndex Parameters

Parameter

Description

nIndex

Specifies the index of a subobject. Index numbers start at one (1); if an object passes zero (0) as the argument to GetObjectByIndex, the function returns a reference to the object or setup that is calling the function rather than any subobject. (This is the same as calling GetObject("").) If a setup calls GetObjectByIndex(0), the reference that is returned does not contain any meaningful information.

Return Values

A reference that can be assigned to a variable of type OBJECT by using the set keyword.

Additional Information

To check whether the object was initialized successfully, call the IsObject function.

To get the number of subobjects contained by the object or setup, call GetObjectCount.