GETTEXT returns the text value of a specified variable on a specified day. GETTEXT is an Advanced Math Toolbox Function.

The GETTEXT Function is no longer supported and is documented here only for backwards compatibility.  See Working with Text Variables in Calculations.

SYNTAX:

GETTEXT(Exp, DateRange, optional TimeIncrement, optional Number of Values)
where :
Exp is any valid WIMS Expression
DateRange is an expression in one of two forms:

1. StartDate TO EndDate

StartDate is a date literal.  If StartDate is NoDate, then the function does not calculate and returns the value BLANK.

EndDate is a date literal.  If EndDate is NoDate, then the function does not calculate and returns the value BLANK.

2. TimeRangeLiteral

A TimeRangeLiteral Defines start and end dates for a time interval specified.  For a listing of available literals, refer to the TimeRange Literal List.

TimeIncrement is an optional parameter that specifies the time frame of the calculation. Default is BYDAY (Daily).  For a listing of available literals, refer to the TimeIncrement Literal List.

Number of Values is an optional parameter that specifies the maximum number of values to process in the date range (default is 0).  If the value is zero, then the function uses all the real values in the date range.  If the number is 5, for example, then the function will only process the first five values in the date range.  If the number of values requested are not found within the date range, then the function returns BLANK.

NOTES:

The Advanced Math Toolbox Functions give full flexibility to WIMS users to create new calculations that are not currently available with the existing, predefined functions.  Since these functions are very general and very powerful, they do not have a lot of safety checks built into them and must be used with caution.  The advanced functions will generally be slightly less efficient than the predefined functions and are not therefore intended to replace the predefined functions.

The main feature of the advanced functions is the ability to specify the date range for the calculations explicitly in the function call.  This allows nonstandard time frames to be used for summation, averaging, geometric means, etc. The functions also allow calculations within the function call and thus are no longer limited to just working on a single variable.  (i.e., you can now take the sum of C2 * C3)

The range of the advanced functions can be specified in two ways:

1. By explicit dates (i.e., sum all values from the beginning of the month to the end of the month.) See Date Literals for more information on specifying dates.
2. By maximum number of values within a date range (i.e., sum the first 5 numbers from the start date to the end date)  These range specifications apply to most of the custom functions.

EXAMPLES:

Example 1: Get the last text value of a variable from the current month.

GETTEXT(C13, #MM/1 TO TodayIf(D = #MM/LL), 1)

C13 : search variable 13 for a text value
#MM/1 : from the first of the current month
TO TodayIf(D = #MM/LL) : to today, if today is the last day of the current month being calculated
1 : only return the last value