PCL Reference Manual > Preference Functions > Report Preferences
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Report Preferences
This section is used to describe some of the functions used to govern some of the preferences used to control the generation of reports.
   
pref_report_get
(real_numbers, float_field_width, float_decimal, sci_field_width, sci_decimal, integer_field_width, number_spacing)
Description:
 
 
This function gets the parameters used to format tabular textual results reports.
Input:
 
 
None.
 
 
Output:
 
 
INTEGER
real_numbers
This value returns the real number switch status.
INTEGER
float_field_width
This value returns the field width used for listing floating point numbers.
INTEGER
float_decimal
This value returns the number of values shown after the decimal point of a floating point number.
INTEGER
sci_field_width
This value returns the field width used to list numbers in scientific notation.
INTEGER
sci_decimal
This value returns the number of values shown after the decimal point of a number in scientific notation.
INTEGER
integer_field_width
This value returns the field width used to list integers.
INTEGER
number_spacing
This value specifies the number of spaces placed between numerical fields.
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
None.
 
 
Remarks:
This function is used in the implementation of the form displayed when the “Report...” selection is picked from the “Preferences” pull down menu.
Example:
Please see pref_report_get.
pref_report_set
(real_numbers, float_field_width, float_decimal, sci_field_width, sci_decimal, integer_field_width, number_spacing)
Description:
 
 
This function sets the parameters used to format tabular textual results reports.
Input:
 
 
INTEGER
real_numbers
This value specifies the real number switch status. The floating point format will be used if this value is set to 1 and the scientific notation format will be used if this value is set to 2.
INTEGER
float_field_width
This value specifies the field width used for listing floating point numbers. This value can range from 3 to 12.
INTEGER
float_decimal
This value specifies the number of values shown after the decimal point of a floating point number. This value can range from 0 to 11.
INTEGER
sci_field_width
This value specifies the field width used to list numbers in scientific notation. This value can range from 6 to 12.
INTEGER
sci_decimal
This value specifies the number of values shown after the decimal point of a number in scientific notation. This value can range from 1 to 7.
INTEGER
integer_field_width
This value returns the field width used to list integers. This value can range from 1 to 12.
INTEGER
number_spacing
This value specifies the number of spaces placed between numerical fields. This value can range from 1 to 20.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
None.
 
 
 
 
Remarks:
This function is used in the implementation of the form displayed when the “Report...” selection is picked from the “Preferences” pull down menu.
Example:
Please see pref_report_set.