ReadStringProperty

InstallShield 2020 ยป InstallScript Language Reference

Project:This information applies to InstallScript projects.

The ReadStringProperty function is called in an object script to read the value of a specified property whose value is a string.

Syntax

ReadStringProperty ( nPropertyBag, szPropertyName, svPropertyValue );

Parameters

ReadStringProperty Parameters

Parameter

Description

nPropertyBag

Specifies a reference to the object's property bag object, in which property values are stored. (The value of nPropertyBag is passed by the setup engine to the ReadProperties function block within which ReadBoolProperty is called. This value is placed in the object script when you use the Add New Property dialog in the InstallScript view.)

szPropertyName

Specifies the name of the property whose value you want to read.

svPropertyValue

Returns the value of the specified property.

Return Values

ReadStringProperty Return Values

Return Value

Description

0

This function always returns zero (0).