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 2.2.6. UnregisterFields UnregisterFields(ItemList, FieldList) This method removes the fields identified by FieldList from the items in ItemList, which should have been registered in the AdxRtList object earlier using RegisterItems. If by using this method all registered fields are removed for an item, this does not unregister the item itself. Arguments ItemList FieldList A list of one or more names as a variant, identifying the items whose fields should be removed. A list of one or more names as a variant, identifying the fields to remove. These must be fields which were named explicitly using the RegisterItems FieldList parameter. Error handling If one of the item names in ItemList or one of the field names in FieldList has not previously been registered in the list object, an error exception is thrown. If the Source has not been set (i.e. the source is in the state RT_SOURCE_NOT_SET) an error exception is thrown. Example Public list as AdxRtList Set list = New AdxRtList Dim ItemList as Variant ItemList = "EUR=" Dim FieldList as Variant FieldList = "ASK" list.UnregisterFields ItemList, FieldList 'Removes the "ASK" field from the item "EUR=" of the list list. ' 2.2.7. StartUpdates StartUpdates(Mode) This method starts the real time update of data for the items registered using RegisterItems in the AdxRtList object. It also establishes the update mode. Arguments Mode A value from the RT_RunMode enumeration. Error handling If Mode contains an invalid value, an error exception is thrown. If the Source has not been set (i.e. the source is in the state RT_SOURCE_NOT_SET) an error exception is thrown. 24
AdfinX Real Time 1.0 Library - User's Guide Example Public list as AdxRtList Set list = New AdxRtList list.StartUpdates RT_MODE_IMAGE 'Requests all items registered in the list list from its source. Once a data image has been received for each of the objects (or a time-out occurs), no more data will be received. This supplies a snapshot of the items. ' 2.2.8. StopUpdates StopUpdates() This method stops the delivery of all updates of items registered in the AdxRtList object to the program but without closing the underlying data stream unless the StartUpdates mode was RT_MODE_IMAGE or the AdxRtList object is in the RT_LIST_LINKS_CLOSED state. This allows updates to be stopped momentarily. To resume updates, the StartUpdates method should be called again. Arguments None Error handling If the Source has not been set (i.e. the source is in the state RT_SOURCE_NOT_SET) an error exception is thrown. Example Public list as AdxRtList Set list = New AdxRtList list.StopUpdates 'Stop the delivery of data for all items registered in the list list.' 2.2.9. CloseAllLinks CloseAllLinks() This method stops the delivery of all updates for items registered in the AdxRtList object to the program and closes down the underlying data stream by informing the data source as required that no more updates will be necessary for those items. Arguments None Error handling If the Source has not been set (i.e. the source is in the state RT_SOURCE_NOT_SET) an error exception is thrown. 25
- 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: 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 and 48: AdfinX Real Time 1.0 Library - User
- Page 49 and 50: 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 />
Example<br />
Public list as AdxRtList<br />
Set list = New AdxRtList<br />
list.StartUpdates RT_MODE_IMAGE<br />
'Requests all items registered in the list list from its source.<br />
Once a data image has been received for each of the objects<br />
(or a time-out occurs), no more data will be received. This<br />
supplies a snapshot of the items. '<br />
2.2.8. StopUpdates<br />
StopUpdates()<br />
This method stops the delivery of all updates of items registered in the AdxRtList object to the<br />
program but without closing the underlying data stream unless the StartUpdates mode was<br />
RT_MODE_IMAGE or the AdxRtList object is in the RT_LIST_LINKS_CLOSED state. This allows<br />
updates to be stopped momentarily. To resume updates, the StartUpdates method should be called<br />
again.<br />
Arguments<br />
<strong>No</strong>ne<br />
Error handling<br />
If the Source has not been set (i.e. the source is in the state RT_SOURCE_NOT_SET) an error<br />
exception is thrown.<br />
Example<br />
Public list as AdxRtList<br />
Set list = New AdxRtList<br />
list.StopUpdates<br />
'Stop the delivery of data for all items registered in the list list.'<br />
2.2.9. CloseAllLinks<br />
CloseAllLinks()<br />
This method stops the delivery of all updates for items registered in the AdxRtList object to the<br />
program and closes down the underlying data stream by informing the data source as required that no<br />
more updates will be necessary for those items.<br />
Arguments<br />
<strong>No</strong>ne<br />
Error handling<br />
If the Source has not been set (i.e. the source is in the state RT_SOURCE_NOT_SET) an error<br />
exception is thrown.<br />
25