Pff.getProperty Function

Format

s = pff_name.getProperty(property_nameʃ, string_listʅ);

Description

The Pff.getProperty function returns a string containing the current value associated with the Pff's property specified by the string expression property_name. PFF properties all have default values, so even if a property was not explicitly defined in the PFF file, it may have a default value. Some properties, such as input data filenames for batch applications, can have multiple values, and if you want to retrieve all of these values, you must supply a string_list, which will contain zero, one, or more strings with the values.

Properties names can be prefixed with the section name, as explained in Pff.setProperty, but it is generally not necessary to do so when using this function.

The function can be used similarly to sysparm to retrieve properties defined in a PFF's [Parameters] section.

Return Value

The function returns a string with the property information. If the property is invalid, a blank string is returned.

Example

// show our custom report unless the PFF specifies ViewListing=Never
Pff this_application_pff;
this_application_pff.load(CENSUS_FF);

if this_application_pff.getProperty("ViewListing") <> "Never" then
view("Disability Statistics.csv");
endif;