This section describes supplementary commands that greatly help the COM client developer. They can be used by replacing the Command argument of the COM Server’s ConnectData method (see RTW COM Interface), which is normally “rt”” or “rtinsert””, with other command strings that are detailed below. These command strings are also valid for the RTD function itself.
For information about RTSHARE-specific commands, see RTSHARE COM Interface Commands.
For example, to obtain the services the mktdemo engine is using in the VB demo code above, the info() string would be set like this:
Info=array("GS","mktdemo")
The following tables provide an overview of the GET and DO commands available for the RTW COM Interface:
Info=array("GC","vsRMDS","IDN","MSFT.O","ASK")
Description | Gets list of currently running engines. |
Command | GE |
Arguments | None |
Return | Value If there are no engines running, the string “(no running engines)” is returned. Otherwise the engine name is returned, or an Excel-style string of a list of engines (e.g.“{mktdemo,vsRMDS2}”). |
Info=array("GE")
Description | Gets whether there is a connection to an engine with valid data requests. |
Command | GD |
Arguments | engine_name |
Return Value | If there are no running engines with data requests “0” is returned. Otherwise “1” is returned. |
info = Array ("GD","vsRMDS")
Description | Gets list of services that the engine is using. |
Command | GS |
Arguments | engine_name |
Return Value | If there are no services in use, the string “(no services)” is returned. Otherwise the service name is returned, or an Excel-style string of a list of services (e.g.“{IDN,RDF}”). |
Info=array("GS","mktdemo")
Description | Gets list of records that engine is subscribed to for a particular service. |
Command | GR |
Arguments | engine_name, service_name |
Return Value | If there are no records in use, the string “(no records)” is returned. Otherwise the record name is returned, or an Excel-style string of a list of records (e.g. “{MSFT,AAPL}”). |
Info=array("GR", "vsRMDS","IDN")
Description | Gets the record info (all fields and values) for a particular record in a particular service. |
Command | GI |
Arguments | engine_name, service_name, record_name |
Return Value | An Excel-style string of the number of fields followed by a list of field ids, field names and field values (e.g.“{2,25,ASK,35.6,22,BID,36.3}”). |
Info=array("GI","vsRMDS","IDN","MSFT.O")
Description | Gets list of fields (and their values) that the engine is subscribed to for a particular record in a particular service. |
Command | GF |
Arguments | engine_name, service_name, record_name |
Return Value | If there are no fields in use the string “(no fields)” is returned. Otherwise an Excel-style string of field names, field values, and field ids is returned (e.g.“{ASK,35.6,1,BID,36.3,2}”). |
Description | Gets the value of a particular field for a particular record in a particular service. |
Command | GC |
Arguments | engine_name, service_name, record_name, field_name |
Return Value | If no match for the field was found, the string “nomatch” is returned. Otherwise the field value is returned e.g. “36.5” |
Description | Gets whether the status window is up (i.e. visible). |
Command | GW |
Arguments | None |
Return Value | If the status window is visible “1” is returned. Otherwise “0” is returned. |
Info=array("GW")
The RTW COM Interface DO Commands are executing tasks.
Description | Toggle: Stops a running engine or starts a stopped engine. |
Command | DS |
Arguments | Engine_name |
Info=array("DS","vsRMDS")
Description | Unsubscribes from a field. |
Command | DU |
Arguments | field_id |
Info=array("DU", "1")
Description | If the window is currently visible, then calling this hides it. If the window is currently hidden, then calling this shows it. |
Command | DW |
Arguments | None |
Info=array("DW")
Description | Performs a login in the Netfeed engine. |
Command | DL |
Arguments | Engine_name, username, password |
Info=array("DL", "vsnf", "jsmith", "abc123")