• <GetStart>
  • CSPro User's Guide
    • The CSPro System
    • Data Dictionary Module
    • The CSPro Language
      • Introduction to CSPro Language
      • Data Requirements
      • CSPro Program Structure
      • Programming Standards
      • Code Folding
      • Debugging CSPro Applications
      • Declaration Section
        • Compiler Mode
        • Variables
        • Alias Statement
        • User-Defined Functions
        • Array Object
        • Audio Object
        • Case Object
        • Document Object
        • File Object
        • Freq Object
        • Geometry Object
        • HashMap Object
        • Image Object
        • List Object
        • Map Object
        • Pff Object
        • SystemApp Object
        • ValueSet Object
      • Procedural Sections
      • Logic
      • Language Elements
    • Data Entry Module
    • Batch Editing Applications
    • Tabulation Applications
    • Data Sources
    • CSPro Statements and Functions
    • Templated Reporting System
    • HTML and JavaScript Integration
    • Action Invoker
    • Appendix
  • <CSEntry>
  • <CSBatch>
  • <CSTab>
  • <DataViewer>
  • <TextView>
  • <TblView>
  • <CSFreq>
  • <CSDeploy>
  • <CSPack>
  • <CSDiff>
  • <CSConcat>
  • <Excel2CSPro>
  • <CSExport>
  • <CSIndex>
  • <CSReFmt>
  • <CSSort>
  • <ParadataConcat>
  • <ParadataViewer>
  • <CSCode>
  • <CSDocument>
  • <CSView>
  • <CSWeb>

Pff Object

In logic, a Pff is an object that contains information about a CSPro Program Information File (.pff). PFF files are used to run CSPro applications or tools in production mode. Using the Pff object in logic, it is possible to dynamically modify the properties used when running an application or tool.
Functionality
A Pff is a CSPro logic object and the following functions can be called via dot notation:
FunctionDescription
loadLoads the contents a PFF file from the disk.
saveSaves a PFF file to the disk.
getPropertyGets the value associated with a PFF property.
setPropertySets the value associated with a PFF property.
execExecutes the application or tool associated with the PFF.
 
getLabelReturns the symbol's label.
getNameReturns the symbol's name.
getJsonReturns the symbol's metadata represented in JSON.
In addition to these object functions, Pff objects can be used as arguments to the filename function.
Assignments
Pff objects can be assigned to other Pff objects, which will replace the Pff's properties with the properties of the assigned Pff:
pff_name = another_pff_name;
When a Pff is used as an argument to a user-defined function, it is passed by reference.
Example
PROC INTERVIEWER_MENU

   
// run the listing program in the interviewer's assigned cluster
    if INTERVIEWER_MENU = 1 then
       
Pff listing_pff;
        listing_pff.
load("Listing.pff");
        listing_pff.
setProperty("Key", maketext("%v", CLUSTER));
        listing_pff.
exec();
   
endif;
See also: Program Information File (.pff)