Reuters AdfinX Real Time 1.0 Library User Guide (Doc. No. 4510529)
Reuters AdfinX Real Time 1.0 Library User Guide (Doc. No. 4510529) Reuters AdfinX Real Time 1.0 Library User Guide (Doc. No. 4510529)
AdfinX Real Time 1.0 Library - User's Guide Values RT_ICV_USERTAG : The item array will contain a column for the item user tags set using the UserTag property. RT_ICV_STATUS : The item array will contain a column holding the status of each item as a value from the RT_ItemStatus enumeration. 6.1.8. RT_FieldColumnView RT_FieldColumnView These values are used as parameters to the AdxRtList ListFields property to specify which information relating to the fields in the item should be selected. Values RT_FCV_USERTAG : The field array will contain a column for the field user tags set using the UserTag property. RT_FCV_STATUS : The field array will contain a column holding the status of each field as a value from the RT_FieldStatus enumeration. RT_FCV_VALUE : The field array will contain a column holding the value of each field as a variant. 6.1.9. RT_RunMode RT_RunMode Values of this type are used by AdxRtList StartUpdates to specify how update signalling should be performed. They are also passed to the OnStatusChange event callback for information. Values RT_MODE_ONTIME_IF_UPDATED : At regular intervals, defined by the "FRQ" attribute of the Mode property, all registered items will be checked to see if any have been updated by the data source since the previous check. For each updated item an OnUpdate event will be generated. RT_MODE_ONTIME : OnTime events will be generated at regular intervals, defined by the "FRQ" attribute of the Mode property, whether or not any data updates have been received for the items in the list. RT_MODE_ONUPDATE : OnUpdate events will be generated for each item in the list every time data updates are received for that item from the source. RT_MODE_IMAGE : An OnImage event will be generated once a single data image has been received for each of the items in the list, or after a time-out. RT_MODE_NOT_SET : No update run mode has been set using the StartUpdates method. 48
AdfinX Real Time 1.0 Library - User's Guide 6.1.10. RT_DataStatus RT_DataStatus This enumeration lists the different values used to describe the status of data retrieved by the objects. Values of this type are passed as parameters to the event callback functions AdxRtList OnImage, AdxRtHistory OnUpdate, and AdxRtChain OnUpdate. The values are also those used by the AdxRtHistory DataStatus and AdxRtChain DataStatus properties. Values RT_DS_FULL : This value indicates that all desired data have been retrieved and are available. RT_DS_PARTIAL : This value indicates that some of the requested data are available, but that the request has not yet been entirely satisfied. RT_DS_NULL_ERROR : This value indicates that an error has occurred and that, consequently, no data are available. RT_DS_NULL_EMPTY : This value indicates that the request returned no data. RT_DS_NULL_TIMEOUT : This value indicates that a timeout occurred before any data could be retrieved. 6.1.11. RT_RunStatus RT_RunStatus This enumeration lists the different states of an object regarding its requests of the source. The properties AdxRtContribute RunStatus, AdxRtHistory RunStatus and AdxRtChain RunStatus return these values. Values RT_RS_READY : The object is ready to be used to make a request for data from a data source. RT_RS_BUSY : The object is currently awaiting a response from the server. For objects that accept multiple data updates from the source, this means that more update events can be expected. RT_RS_NOT_INIT : The object does not have enough information to be able to make a request. 6.1.12. RT_DebugLevel RT_DebugLevel This enumeration lists the valid values for the DebugLevel property of the AdxRtList object. Values RT_DEBUG_NO : No debug messages will be sent. Exceptions indicate invalid parameters and object event interfaces are used to signal system errors. 49
- Page 1 and 2: AdfinX Real Time 1.0 Library User's
- Page 3 and 4: AdfinX Real Time 1.0 Library - User
- Page 5 and 6: AdfinX Real Time 1.0 Library - User
- Page 7 and 8: AdfinX Real Time 1.0 Library - User
- Page 9 and 10: AdfinX Real Time 1.0 Library - User
- Page 11 and 12: AdfinX Real Time 1.0 Library - User
- Page 13 and 14: AdfinX Real Time 1.0 Library - User
- Page 15 and 16: AdfinX Real Time 1.0 Library - User
- Page 17 and 18: AdfinX Real Time 1.0 Library - User
- Page 19 and 20: AdfinX Real Time 1.0 Library - User
- Page 21 and 22: AdfinX Real Time 1.0 Library - User
- Page 23 and 24: AdfinX Real Time 1.0 Library - User
- Page 25 and 26: AdfinX Real Time 1.0 Library - User
- Page 27 and 28: AdfinX Real Time 1.0 Library - User
- Page 29 and 30: AdfinX Real Time 1.0 Library - User
- Page 31 and 32: AdfinX Real Time 1.0 Library - User
- Page 33 and 34: AdfinX Real Time 1.0 Library - User
- Page 35 and 36: AdfinX Real Time 1.0 Library - User
- Page 37 and 38: AdfinX Real Time 1.0 Library - User
- Page 39 and 40: AdfinX Real Time 1.0 Library - User
- Page 41 and 42: AdfinX Real Time 1.0 Library - User
- Page 43 and 44: AdfinX Real Time 1.0 Library - User
- Page 45 and 46: AdfinX Real Time 1.0 Library - User
- Page 47: AdfinX Real Time 1.0 Library - User
- Page 51: AdfinX Real Time 1.0 Library - User
<strong>AdfinX</strong> <strong>Real</strong> <strong>Time</strong> <strong>1.0</strong> <strong>Library</strong> - <strong>User</strong>'s <strong>Guide</strong><br />
6.1.10. RT_DataStatus<br />
RT_DataStatus<br />
This enumeration lists the different values used to describe the status of data retrieved by the objects.<br />
Values of this type are passed as parameters to the event callback functions AdxRtList OnImage,<br />
AdxRtHistory OnUpdate, and AdxRtChain OnUpdate. The values are also those used by the<br />
AdxRtHistory DataStatus and AdxRtChain DataStatus properties.<br />
Values<br />
RT_DS_FULL : This value indicates that all desired data have been retrieved<br />
and are available.<br />
RT_DS_PARTIAL : This value indicates that some of the requested data are<br />
available, but that the request has not yet been entirely<br />
satisfied.<br />
RT_DS_NULL_ERROR : This value indicates that an error has occurred and that,<br />
consequently, no data are available.<br />
RT_DS_NULL_EMPTY : This value indicates that the request returned no data.<br />
RT_DS_NULL_TIMEOUT : This value indicates that a timeout occurred before any data<br />
could be retrieved.<br />
6.1.11. RT_RunStatus<br />
RT_RunStatus<br />
This enumeration lists the different states of an object regarding its requests of the source. The<br />
properties AdxRtContribute RunStatus, AdxRtHistory RunStatus and AdxRtChain<br />
RunStatus return these values.<br />
Values<br />
RT_RS_READY : The object is ready to be used to make a request for data<br />
from a data source.<br />
RT_RS_BUSY : The object is currently awaiting a response from the server.<br />
For objects that accept multiple data updates from the<br />
source, this means that more update events can be<br />
expected.<br />
RT_RS_NOT_INIT : The object does not have enough information to be able to<br />
make a request.<br />
6.1.12. RT_DebugLevel<br />
RT_DebugLevel<br />
This enumeration lists the valid values for the DebugLevel property of the AdxRtList object.<br />
Values<br />
RT_DEBUG_NO : <strong>No</strong> debug messages will be sent. Exceptions indicate invalid<br />
parameters and object event interfaces are used to signal<br />
system errors.<br />
49