Reuters AdfinX Real Time 1.0 Library User Guide (Doc. No. 4510529)

AdfinX Real Time 1.0 Library - User's Guide
5. ADXRTHISTORY
5.1. ADXRTHISTORY PROPERTIES
5.1.1. Mode
Mode
This property describes how the Data property is to present its results. It is a string which should
contain a sequence of parameter settings. It also allows the definition of the range of dates over which
historical data is to be retrieved. The allowed parameters are:
END : The End Date parameter fixes the last date for which historical data should
be retrieved.
END:ddmmmyy sets an end date of ddmmmyy.
By default data will be retrieved up to the current date.
HEADER : The Header attribute determines whether a “header” row of field names
should be returned with the data.
HEADER:YES include a header row.
HEADER:NO do not include a header row (default).
If the keyword HEADER is present on its own, it is treated as HEADER:YES.
FRQ : The Frequency parameter establishes the predefined time-series to consult.
FRQ:D
Fetch daily data (default).
FRQ:W
Fetch weekly data.
FRQ:M
Fetch monthly data.
FRQ:other
Fetch data of the frequency specified by the letter
other. This frequency must be supported by the
source.
LAY : The Layout attribute determines how the elements will be arranged in the
returned array.
LAY:HOR or LAY:H returns items in a horizontal layout.
LAY:VER or LAY:V returns items in a vertical layout.
NBEVENTS : The Number of Events parameter limits the number of historical events that
will be retrieved.
NBEVENTS:n return data for no more than n events.
The default value depends on the frequency setting as follows:
NBEVENTS:25 with a daily frequency (FRQ:D).
NBEVENTS:52 with a weekly frequency (FRQ:W).
NBEVENTS:12 with a monthly frequency (FRQ:M).
NBEVENTS:25 with any other frequency (FRQ:other).
EVENTS : Exact number of historical data retrieved {i with i as integer}
EVENTS:i to retrieve i data points (see the NBEVENTS keyword and the
Note section below.)
NULL : The Null attribute dictates how empty entries should be handled.
NULL:NA
provide the string value "#N/A ND" instead of null
values (default).
NULL:REPEAT copy earlier valid values to this entry, if any.
NULL:SKIP drop the entry in the returned array.
RET : The Return parameter allows the size of the returned array to be controlled.
RET:An
return the first n entries of the array as an array.
RET:n
return only the n th entry of the array (entries are
numbered from 1).
By default no return array size is defined.
41