Pff.load Function

Format

b = pff_name.load(pff_filename ‖ application_name);

Description

The Pff.load function loads the contents from an existing PFF file into a Pff object. If supplying a string expression, pff_filename, the properties from that PFF will be loaded. If supplying an application_name (the name of your application, which generally ends with _FF), then the PFF used to run the current application will be loaded.

Return Value

The function returns a logical value of 1 (true) if the PFF file exists and was successfully loaded and 0 (false) otherwise.

Example 1

// run the household data entry application but change the name
// of the data file to the current cluster
Pff household_pff;
household_pff.load("Household.pff");
household_pff.setProperty("InputData", maketext("%v.csdb", CLUSTER));
household_pff.exec();

Example 2

function DisplayMinorMessage(string message_text)

// do not display minor messages when running this batch
// application and only showing summary messages
Pff this_application_pff;
this_application_pff.load(CENSUS_FF);

if this_application_pff.getProperty("ErrmsgOverride") <> "Summary" then
errmsg("%s", message_text);
endif;

end;

See also: Pff Object, Pff.save Function