Functional Description
Purpose
The general function of this program is to store in memory a summary of the records printed by the
UBE R76C0002; values that will be retrieved at the end of the UBE. The program will store or retrieve
the records depending on the value that the parameter cCacheActionCode takes. If this parameter takes
a value of 1, the record is stored in Memory. If the parameter takes a value of 2, the record
retrieved is the record stored in the position that the parameter idPointerToCursor indicates. If the
parameter cCacheActionCode is 3, the cache is destroyed.
Setup Notes and Prerequisites
• The parameter cCacheActionCode must have a value either 1, 2 or 3.
• If the value of the parameter cCacheActionCode is equal to 2, you must provide either the position
in memory of the record to be read or the key for the first record stored in Cache.
• Before calling the function with an action code of 2 you must have called the function with a value
of 1.
• When finished retrieving all the records you must terminate the Cache by calling the function with
an action code of 3.
Special Logic
• If the Pointer to cursor is null, the record retrieved will be the first record found with the key
given as a parameter.
Technical Specifications
Parameters:
DL01szAccountOrTaxAreaI/ORequiredIf
cCacheActionCode=1
DL01szDescriptionI/ONo Required
Account Description
or Tax Area
Description.
ATXAmnAmountTaxableI/ONo Required.
Taxable Amount
STAMmnAmountTaxI/ONo Required.
Tax Amount
EV01cCacheActionCodeIRequired.
Action Code.
1 - Store
2 - Retrieve
3 - Destroy
DTAIszErrorMessageONo Required.
If any problem
occurs when the
cache is
initialized or the
record is stored or
the record is
retrieved. The
error message is
returned in this
parameter.
GENLNGidPointerToCursorI/ORequired.
This parameter is
required when the
record to retrieve
is different to the
first.
^
D76C0019A - Tax Report Store And Retrieve Printed Values - COL - 76C
| Parameter Name | Data Item | Data Type | Req/Opt | I/O/Both |
|---|---|---|---|---|
| szAccountOrTaxArea | DL01 | char | NONE | NONE |
A user defined name or remark. | ||||
| szDescription | DL01 | char | NONE | NONE |
A user defined name or remark. | ||||
| mnAmountTaxable | ATXA | MATH_NUMERIC | NONE | NONE |
The amount on which taxes are assessed. | ||||
| mnAmtTax | STAM | MATH_NUMERIC | NONE | NONE |
The amount assessed and payable to tax authorities. It is the total of the VAT, use, and sales taxes (PST). | ||||
| cCacheActionCode | EV01 | char | NONE | NONE |
An option that specifies the type of processing for an event. | ||||
| szErrorMessage | DTAI | char | NONE | NONE |
A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or
| ||||
| idPointerToCursor | GENLNG | ID | NONE | NONE |
General purpose ID variable. | ||||
| None |
| None |