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

More documents

Recommendations

Info

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 21: AdfinX Real Time 1.0 Library - User
Page 51: AdfinX Real Time 1.0 Library - User

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

Create successful ePaper yourself

Delete template?

Save as template?