GetInstallSize
Previous Topic  Next Topic 

::InstallAPI::GetInstallSize


Get the required install size for a given object.  The object can be a Setup Type, Component or File Group.


Note

With no options at all, this API returns the size that is required for the currently-selected components in the install.



Supported Platforms

All



Returns

The install size required for the given object.



Options


-activeonly <boolean>

If this option is true, only active objects will be added to the total install size.  This option is true by default.


-object <object ID or alias>

The object can be a Setup Type, Component or File Group to return the size of.  If no object is specified, the install size of the currently-selected options by the user will be returned.