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 Arguments None Return Value This property returns a value taken from the RT_DataStatus enumeration. 4.1.10. RunStatus RunStatus This property allows the application to know whether the object is currently retrieving chain data. Arguments None Return Value This function returns a one of the values listed in the RT_RunStatus enumeration. 4.1.11. SourceStatus SourceStatus This property returns a value from the RT_SourceStatus enumeration. This value reflects the status of the source defined by the Source property of the AdxRtChain object. Arguments None Return Value Returns the status of the source of the list object. 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 chain as AdxRtChain Set chain = New AdxRtChain chain.Source = "IDN_SELECTFEED" Status = chain.SourceStatus 'Sets Status to the status of the "IDN_SELECTFEED" source; this might be RT_SOURCE_UP or RT_SOURCE_DOWN, for example.' 38
AdfinX Real Time 1.0 Library - User's Guide 4.2. ADXRTCHAIN METHODS 4.2.1. RequestChain RequestChain() This method fetches the data for the chain specified by the Source and ItemName parameters. This action occurs asynchronously; the arrival of chain data, or an indication of a request error, causes the OnUpdate event to occur. Arguments None Example Dim chain as AdxRtChain Set chain = New AdxRtChain chain.Source = "IDN" chain.ItemName = ".FCHI" chain.Mode = "IGNE:YES" chain.RequestChain 'Set the chain item’s source.' 'Set the chain item’s name.' 'Remove empty entries.' 'Ask for the chain data.' 4.3. ADXRTCHAIN EVENTS 4.3.1. OnUpdate OnUpdate(DataStatus) This callback handles updates to the requested data. If the Update When Completed attribute is in effect (see the "UWC" keyword of the Mode property), this will occur only once all chain data have been retrieved, or some request error occurs. Otherwise, the event may be called a number of times before all data have arrived. If the Live attribute is active (see the "LIVE" keyword of the Mode property), updates may continue to arrive following the completion of the chain’s data, as the source sends changes to the chain’s contents. Arguments DataStatus The status of the data retrieved by the request. This is a value taken from the RT_DataStatus enumeration. 4.3.2. OnStatusChange OnStatusChange(SourceStatus) This callback is called every time a change occurs to the status of the data source specified by the Source property while there is an outstanding RequestChain request. 39
- 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: 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 />
4.2. ADXRTCHAIN METHODS<br />
4.2.1. RequestChain<br />
RequestChain()<br />
This method fetches the data for the chain specified by the Source and ItemName parameters. This<br />
action occurs asynchronously; the arrival of chain data, or an indication of a request error, causes the<br />
OnUpdate event to occur.<br />
Arguments<br />
<strong>No</strong>ne<br />
Example<br />
Dim chain as AdxRtChain<br />
Set chain = New AdxRtChain<br />
chain.Source = "IDN"<br />
chain.ItemName = ".FCHI"<br />
chain.Mode = "IGNE:YES"<br />
chain.RequestChain<br />
'Set the chain item’s source.'<br />
'Set the chain item’s name.'<br />
'Remove empty entries.'<br />
'Ask for the chain data.'<br />
4.3. ADXRTCHAIN EVENTS<br />
4.3.1. OnUpdate<br />
OnUpdate(DataStatus)<br />
This callback handles updates to the requested data. If the Update When Completed attribute is in<br />
effect (see the "UWC" keyword of the Mode property), this will occur only once all chain data have been<br />
retrieved, or some request error occurs. Otherwise, the event may be called a number of times before<br />
all data have arrived.<br />
If the Live attribute is active (see the "LIVE" keyword of the Mode property), updates may continue to<br />
arrive following the completion of the chain’s data, as the source sends changes to the chain’s<br />
contents.<br />
Arguments<br />
DataStatus<br />
The status of the data retrieved by the request. This is a value taken from the<br />
RT_DataStatus enumeration.<br />
4.3.2. OnStatusChange<br />
OnStatusChange(SourceStatus)<br />
This callback is called every time a change occurs to the status of the data source specified by the<br />
Source property while there is an outstanding RequestChain request.<br />
39