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. ADXRTLIST 2.1. ADXRTLIST PROPERTIES 2.1.1. Source Source Name of the data source as a string. Arguments None Error Handling Depends on the value of the DebugLevel general property, as follows: RT_DEBUG_NO If the source is already known as invalid or down, an exception is raised. If the status of the source is unknown, then the process continues without any warning or error. RT_DEBUG_IMMEDIATE When using SSL, the source is checked for validity. If it is not valid an exception is raised before setting a new property value. If the source is unknown or down an exception is raised. It is important to note that in this mode the setting of the Source property could be very slow. Example Public list as AdxRtList Set list = New AdxRtList 'Declare as global variable' 'Create an instance of the list object. This syntax is more efficient than when only the new instruction is used. Otherwise, before execution, Visual Basic will test each statement containing list for the value Nothing. ' list.Source = "IDN_SELECTFEED" 'Set the source name to "IDN_SELECTFEED"' 2.1.2. Mode Mode This property describes various behavioural aspects of the AdxRtList object. In particular, it determines how the list object will deliver data update events to the client application. The allowed parameters are: FRQ : The frequency of regularly generated events. If the list’s StartUpdates method was called with the run mode value RT_MODE_ONTIME or RT_MODE_ONTIME_IF_UPDATED, OnTime events will be triggered at this frequency. The minimum frequency is one event per second. FRQ:iH set a frequency of one event every i hours. FRQ:iM set a frequency of one event every i minutes. FRQ:iS set a frequency of one event every i seconds. The default frequency is one event every 10 seconds. 10
AdfinX Real Time 1.0 Library - User's Guide TIMEOUT : The maximum time in seconds to allow for the arrival of data images for the items of the list. TIMEOUT:i set a timeout period of i seconds. By default, its value is zero, indicating that no timeout is in effect. Arguments None Example Public list as AdxRtList Set list = New AdxRtList 'Declare as global variable' 'Create an instance of the list object. This syntax is more efficient than when only the new instruction is used. Otherwise, before execution, Visual Basic will test each statement containing list for the value Nothing. ' list.Source = "IDN_SELECTFEED" 'Set the source name to "IDN_SELECTFEED"' list.StartUpdates RT_MODE_TIME list.Mode = "FRQ:10s" 2.1.3. DebugLevel DebugLevel This property defines the support for debugging provided by the AdxRtList object. It takes a value from the RT_DebugLevel enumeration. Arguments None 2.1.4. ErrorMode ErrorMode This property sets the error mode for the object. When an error is detected, this property is consulted to see what action should be taken by the object to inform the user of the application. It must be assigned a value from the AdxErrorMode enumeration. By default the error mode is set to EXCEPTION. Arguments None 2.1.5. ErrorCode ErrorCode This property retrieves the error code of the latest error encountered by the object as an integer value. If the ErrorMode property of the object is set to NO_EXCEPTION, this value must be consulted by the client application to determine whether an error has occurred. 11
- 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: 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 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 />
TIMEOUT : The maximum time in seconds to allow for the arrival of data images for the<br />
items of the list.<br />
TIMEOUT:i set a timeout period of i seconds.<br />
By default, its value is zero, indicating that no timeout is in effect.<br />
Arguments<br />
<strong>No</strong>ne<br />
Example<br />
Public list as AdxRtList<br />
Set list = New AdxRtList<br />
'Declare as global variable'<br />
'Create an instance of the list object. This syntax is more<br />
efficient than when only the new instruction is used. Otherwise,<br />
before execution, Visual Basic will test each statement<br />
containing list for the value <strong>No</strong>thing. '<br />
list.Source = "IDN_SELECTFEED"<br />
'Set the source name to "IDN_SELECTFEED"'<br />
list.StartUpdates RT_MODE_TIME<br />
list.Mode = "FRQ:10s"<br />
2.1.3. DebugLevel<br />
DebugLevel<br />
This property defines the support for debugging provided by the AdxRtList object. It takes a value<br />
from the RT_DebugLevel enumeration.<br />
Arguments<br />
<strong>No</strong>ne<br />
2.1.4. ErrorMode<br />
ErrorMode<br />
This property sets the error mode for the object. When an error is detected, this property is consulted<br />
to see what action should be taken by the object to inform the user of the application. It must be<br />
assigned a value from the AdxErrorMode enumeration.<br />
By default the error mode is set to EXCEPTION.<br />
Arguments<br />
<strong>No</strong>ne<br />
2.1.5. ErrorCode<br />
ErrorCode<br />
This property retrieves the error code of the latest error encountered by the object as an integer value.<br />
If the ErrorMode property of the object is set to NO_EXCEPTION, this value must be consulted by the<br />
client application to determine whether an error has occurred.<br />
11
Change language