fgl_report_loadCurrentSettings

Loads the report definition and configures the in-memory settings accordingly.

Syntax

fgl_report_loadCurrentSettings (
   reportFileName STRING) 
  RETURNING ok INTEGER
  1. reportFileName - Name of the 4rp report file to process (extract the settings information). The settings are made using the Configuration menu of the Report Design page. If a relative path is specified, then it is first converted to an absolute path against the current working directory, then against FGLRESOURCEPATH, and finally against DBPATH.

    The value denotes a path on the machine where the Genero Report Engine is running. In the case of distributed processing, this may be a different machine than the machine running the dynamic virtual machine (DVM). When running a legacy Genero BDL report using Report Writer, the reportFileName should be NULL.

    This indicates the ASCII output from the BDL file is to be written to the "SVG" device in preview mode.

  2. ok - Returns TRUE if no error occurred.
Important: If your files are loaded asynchronously, a successful call to the fgl_report_loadCurrentSettings() function does not guarantee that the file has loaded successfully. If your system is configured to load files asynchronously, it is recommended that you call fgl_report_getErrorStatus() after every call to START REPORT, OUTPUT TO REPORT, and FINISH REPORT.

Usage

This function loads the specified 4rp file and configures the current in-memory settings accordingly. Calling this function is a required prerequisite to calling fgl_report_commitCurrentSettings().

The call sequence is the following:
CALL fgl_report_loadCurrentSettings(filename)
--- Optional functions to change default settings
CALL fgl_report_commitCurrentSettings()

See Usage.