Difference between revisions of "GRF - Access any Currency (Reports & Settings Report Generator function)"

From Catalyst
Jump to: navigation, search
(Updated from revision control)
(New redirection changes)
(Tag: New redirect)
 
Line 1: Line 1:
__NOTOC__
+
#REDIRECT [[GRF - Access any currency details (Reports & Settings Report Generator function)]]
== Syntax ==
 
'''$GRF'''{currency, expression}
 
 
 
== Description ==
 
In general, changes the Currency Code being reported on.
 
 
 
== Parameters ==
 
;currency
 
:A text parameter that can be omitted.
 
:Currency code to use (see below).
 
;expression
 
:A text or numeric parameter that can be omitted.
 
:Variable or formula to evaluate (see below).
 
 
 
== Returns ==
 
A text or numeric (depending on the parameters) value.
 
This function may be used in three ways.
 
 
 
;All parameters are supplied.
 
{{Example|text=
 
$GRF{A32,F02}
 
}}
 
 
 
:The result of the given expression using the details of the currency code supplied is returned. For the example above, (using the variable [[A32 - Account Currency Code (Reports & Settings Report Generator variable)|A32]]), the name of the currency for the current account would be returned.
 
;No expression is supplied.
 
{{Example|text=
 
$GRF{A32}
 
}}
 
 
 
:Changes the currency code being reported on; i.e. all "F" variables (and other variables which use the currency code being reported on), in the remainder of the current block will use the details from the currency code supplied. If used in a Range screen then this will affect the whole report. If no expression is supplied, the actual result of the function will be numeric - "1" if the currency exists or "0" if otherwise.
 
;No parameters are supplied.
 
{{Example|text=
 
$GRF{}
 
}}
 
 
 
:The function may be used in this way in a block after using the function as in method 2, to change the currency being reported on back to the previous value.
 
 
 
[[Category:Reports & Settings Report Generator functions]]
 

Latest revision as of 05:51, 16 April 2020