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.3. RegisterItems RegisterItems(ItemList, FieldList) This method adds a list of items with a corresponding list of associated fields to the AdxRtList object. Registering the items allows for retrieval of item data from the object’s data source (defined by the Source property). Arguments ItemList FieldList An array of variant of one or more item names. An array of variant of one or more field names. It is possible, by specifying the single value "*", to request all fields present in the items. (This functionality depends on the system used to provide access to the data sources.) Return Value If successful, this method returns RT_OK, otherwise it returns the error status RT_ERR. An error means that the FieldList is not correctly set and that at least one field is undefined (has a field status of RT_FIELD_UNDEFINED). Error handling Depends on the value of the DebugLevel general property, as follows: RT_DEBUG_NO If one of the items in the ItemList or one of the fields in the FieldList is already known to be invalid, an exception is thrown notifying the user about it. RT_DEBUG_IMMEDIATE On direct API platforms, for each item in the ItemList, an initial event callback is used to determine whether the item or any of the requested fields within it is invalid. If so, an exception is thrown accordingly. It is important to note that in this mode the registration process can be very slow. Example Public list as AdxRtList Set list = New AdxRtList Dim ItemList(0 To 1) as Variant ItemList(0) = "EUR=" ItemList(1) = "JPY=" Dim FieldList(0 To 1) as Variant FieldList(0) = "BID" FieldList(1) = "ASK" list.RegisterItems ItemList, FieldList 'Adds the items "EUR=" and "JPY=" to the list list. For each of these items, the fields "BID" and "ASK" are required. ' 22
AdfinX Real Time 1.0 Library - User's Guide 2.2.4. UnregisterItems UnregisterItems(ItemList) This method removes a list of items from the AdxRtList object which were previously registered with RegisterItems. If the object is receiving events (data have been requested using the StartUpdates method), no more information will be received by the object concerning these items. Arguments ItemList A list of one or more names as a variant, identifying the items to remove from the list. Error handling If one of the item names in ItemList 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 = Array("EUR=", "JPY=") list.UnregisterItems ItemList 'Removes the item "EUR=" from the list list. ' 2.2.5. UnregisterAllItems UnregisterItems() This method removes all items from the AdxRtList object which were previously registered with RegisterItems. If the object is receiving events (data have been requested using the StartUpdates method), no more information will be received by the object, as if the StopUpdates method were called. 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.UnregisterAllItems 'Removes all registered items from the list list. ' ItemCount = list.ItemListCount 'This sets ItemCount to 0. ' 23
- 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: 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 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 />
2.2.3. RegisterItems<br />
RegisterItems(ItemList, FieldList)<br />
This method adds a list of items with a corresponding list of associated fields to the AdxRtList<br />
object. Registering the items allows for retrieval of item data from the object’s data source (defined by<br />
the Source property).<br />
Arguments<br />
ItemList<br />
FieldList<br />
An array of variant of one or more item names.<br />
An array of variant of one or more field names. It is possible, by specifying<br />
the single value "*", to request all fields present in the items. (This<br />
functionality depends on the system used to provide access to the data<br />
sources.)<br />
Return Value<br />
If successful, this method returns RT_OK, otherwise it returns the error status RT_ERR. An error means<br />
that the FieldList is not correctly set and that at least one field is undefined (has a field status of<br />
RT_FIELD_UNDEFINED).<br />
Error handling<br />
Depends on the value of the DebugLevel general property, as follows:<br />
RT_DEBUG_NO<br />
If one of the items in the ItemList or one of the fields in the FieldList is already known<br />
to be invalid, an exception is thrown notifying the user about it.<br />
RT_DEBUG_IMMEDIATE<br />
On direct API platforms, for each item in the ItemList, an initial event callback is used to<br />
determine whether the item or any of the requested fields within it is invalid. If so, an<br />
exception is thrown accordingly. It is important to note that in this mode the registration<br />
process can be very slow.<br />
Example<br />
Public list as AdxRtList<br />
Set list = New AdxRtList<br />
Dim ItemList(0 To 1) as Variant<br />
ItemList(0) = "EUR="<br />
ItemList(1) = "JPY="<br />
Dim FieldList(0 To 1) as Variant<br />
FieldList(0) = "BID"<br />
FieldList(1) = "ASK"<br />
list.RegisterItems ItemList, FieldList<br />
'Adds the items "EUR=" and "JPY=" to the list list. For each<br />
of these items, the fields "BID" and "ASK" are required. '<br />
22