SET DDECONV
| DDECONV Item | |||
|---|---|---|---|
| NEW | SET | ATTRIBUTES | MESSAGES |
See DDECONV Item Attributes for a list of item attributes.
The DDECONV shell item supports the following SET commands:
Contents
POKE
SET conv POKE item format data
Poke the item with data in the specified format.
| conv | the established conversation |
| item | the item you wish to poke data to |
| format | the format or data-type of data (see conv[!SERVICEFORMATS] for the formats supported by the conversation's server and 'SET conv REQUEST' for the formats supported by STx)
|
| data | the data you want to poke (a string variable or a shell-table) |
Example
Send table myTable to Excel using the previously established conversation myExcelConv. Excel will fill the area r1c1:r10c2 with the first 10 rows (entries) and first 2 columns (fields) of myTable:
SET myExcelConv POKE "r1c1:r10c2" xltable myTable
The full path is necessary for a document topic in Winword (e.g. "C:\Files\Mydocument.doc"). A bookmark (as item) is necessary for inserting text into a word document.
Note that the German version of Excel will not understand 'r1c1:r10c2', since rows are called Zeilen and columns are called Spalten; for communication with a German version of Excel, please use 'z1s1:z10s2'.
REQUEST
SET conv REQUEST item format data [timeout]
Request the data from item. The macro waits up to timeout milliseconds for the server to return the data.
| conv | the established conversation | ||||||||
| item | the item you wish to get data for | ||||||||
| format | the format or data-type of data. Can be one of the following:
| ||||||||
| data | the data variable. This is either a string for formats TEXT and UNICODETEXT, or a table for formats XLTABLE or CSV.
| ||||||||
| timeout | number of milliseconds we should wait for server to return before we fail |
ADVISE
SET conv ADVISE item format [data] /Hot|Warm
Initiate an advise loop. The ADVISE message will be sent when the item's data changes. If a link is hot (/Hot) the server notifies the client whenever the requested data changes and immediately sends the new data to the client (STx). For a hot link, the value item data is necessary (because data is automatically updated). If the link is warm (/Warm) the server notifies the client whenever the requested data changes but sends the new data only after an explicit request from the client. To request the data command 'SET conv REQUEST' is used.
| conv | the conversation |
| item | the item with the data |
| data | the data variable |
| format | the format of data-type of data |
STOPADVISE
SET conv STOPADVISE [item]
Stop an advise loop. If item is not specified, all advise loops for this conversation are stopped.
| conv | the conversation |
| item | the item with the data |
EXECUTE
SET conv EXECUTE command
Execute the command.
| conv | the conversation |
| command | the command string to execute |
