sys.get_gtot()

Purpose:

Return Grand Total Val

sys.get_gtot() returns the current grand total val of a CB TOT Var for the CB EOF Group for a particular CB.

Usage:

tot = sys.get_gtot(<cbtot>);
tot = sys.get_gtot(<CBNAME>,<cbtot>);



          Or more generally



tot = sys.get_gtot([<CBNAME>,]<cbtot>);

In most cases, sys.get_gtot() will be used with one argument. When used this way, it will work with the current CB.

Optional arguments are allowed so that you can get grand total vals without needing to be processing a particular CB.

Arguments:

<CBNAME> - The name of the CB that you need to get a total val for. This is an optional argument. If it is not passed, then sys.get_gtot() uses the current CB.

<cbtot> - The name of the CB TOT Var to return the grand total val for. This argument must always be specified.

Returns: sys.get_gtot() can return integer or float. Since any value is valid for a tot, there is no way to return a unique bad value, however sys.get_gtot() will try to return a bad value when necessary. A bad return for a float is -1.0, and a bad ret for an integer is -1. Thus the following may be considered bad returns sometimes, but they could also be perfectly valid.

-1.0 - OR

-1 - Either <CBNAME> or <cbtot> is invalid.

AnyValue - The current grand total of the CB TOT Var for specified CB.

Where Used:

sys.get_gtot() can be called from anywhere as long as there is an active driver with <CBNAME> set appropriately to either CB_DRPROC or CB_DRSEL.

Example:

The following example gets the current grand total value for the CB TOT Var sys.pr_syssize for the current CB.

tot = sys.get_gtot(sys.pr_syssize);

Description:

sys.get_gtot() returns the current total val of a CB TOT Var for a CB EOF Group for a particular CB. This is called the grand total of the TOT Var for the CB. It can be called with 1 or 2 arguments.

If called with 1 arg, the arg is <cbtot>. sys.get_gtot() will return the current grand total val of the CB TOT Var for the Current CB.

If used with 2 args, the args are <CBNAME> and <cbtot>. sys.get_gtot() will return the current grand total val of the CB TOT Var for the specified CB. You may want to use sys.get_gtot() in this manner if you need to access a grand total val of a particular CB outside current CB processing.

Thus, you can get any CB TOT Var grand total val for any currently active CB from any PCL.

4C maintains grand total values for each CB TOT Var that was defined as TOT. The Grand Total Val of a CB TOT Var is the same as the Total Val of the CB TOT Var for the CB EOF Group. This value is updated at the same time that totals are updated. That is, the grand total value is updated after the rcd has been CB Selected and before running the DRSELECT or DRPROC PCL. The grand total vals are never reset to null.

Bugs/Features/Comments:

See Also: sys.get_count() sys.get_gcount() sys.get_max() sys.get_gmax() sys.get_min() sys.get_gmin() sys.get_tot() sys.get_gtot()