Programmer Guide/Shell Items/DDECONV/SET DDECONV - Revision history

Jw at 06:34, 10 April 2015

2015-04-10T06:34:13Z

← Older revision		Revision as of 08:34, 10 April 2015
Line 1:		Line 1:
			{{DDECONV Item}}
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	See [[Programmer Guide/Shell Items/DDECONV/DDECONV Item Attributes\|<code>DDECONV</code> Item Attributes]] for a list of item attributes.		See [[Programmer Guide/Shell Items/DDECONV/DDECONV Item Attributes\|<code>DDECONV</code> Item Attributes]] for a list of item attributes.

Christian at 12:27, 31 October 2012

2012-10-31T12:27:01Z

← Older revision		Revision as of 14:27, 31 October 2012
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	See [[Programmer Guide/Shell Items/DDECONV/DDECONV Item Attributes\|DDECONV Item Attributes]] for a list of item attributes.		See [[Programmer Guide/Shell Items/DDECONV/DDECONV Item Attributes\|<code>DDECONV</code> Item Attributes]] for a list of item attributes.

	The [[Programmer_Guide/Shell_Items/DDECONV\|<code>DDECONV</code> shell item]] supports the following <code>SET</code> commands:		The [[Programmer_Guide/Shell_Items/DDECONV\|<code>DDECONV</code> shell item]] supports the following <code>SET</code> commands:

Christian: /* EXECUTE */

2012-10-31T12:26:31Z

EXECUTE

← Older revision		Revision as of 14:26, 31 October 2012
Line 111:		Line 111:
	== <code>EXECUTE</code> ==		== <code>EXECUTE</code> ==

	SET conv EXECUTE <var>command</var>		SET <var>conv</var> EXECUTE <var>command</var>

	Execute the <var>command</var>.		Execute the <var>command</var>.
Line 120:		Line 120:
	\|the conversation		\|the conversation
	\|-		\|-
	\|command		\|<var>command</var>
	\|the command string to execute		\|the command string to execute
	\|}		\|}

Christian: /* STOPADVISE */

2012-10-31T12:26:09Z

STOPADVISE

← Older revision		Revision as of 14:26, 31 October 2012
Line 100:		Line 100:
	Stop an advise loop. If <var>item</var> is not specified, all advise loops for this conversation are stopped.		Stop an advise loop. If <var>item</var> is not specified, all advise loops for this conversation are stopped.

	{\|		{\| class="einrahmen"
	\|-		\|-
	\|conv		\|<var>conv</var>
	\|the conversation		\|the conversation
	\|-		\|-
	\|item		\|<var>item</var>
	\|the item with the data		\|the item with the data
	\|}		\|}

	== <code>EXECUTE</code>		== <code>EXECUTE</code> ==

	SET conv EXECUTE <var>command</var>		SET conv EXECUTE <var>command</var>

Christian: /* ADVISE */

2012-10-31T12:25:35Z

ADVISE

← Older revision		Revision as of 14:25, 31 October 2012
Line 75:		Line 75:
	== <code>ADVISE</code> ==		== <code>ADVISE</code> ==

	SET conv ADVISE <var>item format</var> [<var>data</var>] /Hot\|Warm		SET conv ADVISE <var>item</var> <var>format</var> [<var>data</var>] /Hot\|Warm

	Initiate an advise loop. The <code>[[Programmer Guide/Shell Items/DDECONV/DDECONV messages\|ADVISE]]</code> 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 <var>data</var> is necessary (because <var>data</var> 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 '<code>SET conv REQUEST</code>' is used.		Initiate an advise loop. The <code>[[Programmer Guide/Shell Items/DDECONV/DDECONV messages\|ADVISE]]</code> 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 <var>data</var> is necessary (because <var>data</var> 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 '<code>SET conv REQUEST</code>' is used.
Line 84:		Line 84:
	\|the conversation		\|the conversation
	\|-		\|-
	\|item		\|<var>item</var>
	\|the item with the data		\|the item with the data
	\|-		\|-
	\|data		\|<var>data</var>
	\|the data variable		\|the data variable
	\|-		\|-
	\|format		\|<var>format</var>
	\|the format of data-type of <var>data</var>		\|the format of data-type of <var>data</var>
	\|}		\|}

Christian: /* REQUEST */

2012-10-31T12:24:59Z

REQUEST

← Older revision		Revision as of 14:24, 31 October 2012
Line 37:		Line 37:
	== <code>REQUEST</code> ==		== <code>REQUEST</code> ==

	SET <var>conv</var> REQUEST <var>item format data</var> [<var>timeout</var>]		SET <var>conv</var> REQUEST <var>item</var> <var>format</var> <var>data</var> [<var>timeout</var>]

	Request the <var>data</var> from <var>item</var>. The macro waits up to <var>timeout</var> milliseconds for the server to return the <var>data</var>.		Request the <var>data</var> from <var>item</var>. The macro waits up to <var>timeout</var> milliseconds for the server to return the <var>data</var>.
Line 43:		Line 43:
	{\| class="einrahmen"		{\| class="einrahmen"
	\|-		\|-
	\|conv		\|<var>conv</var>
	\|the established conversation		\|the established conversation
	\|-		\|-
	\|item		\|<var>item</var>
	\|the item you wish to get data for		\|the item you wish to get data for
	\|-		\|-
	\|format		\|<var>format</var>
	\|the format or data-type of <var>data</var>. Can be one of the following:		\|the format or data-type of <var>data</var>. Can be one of the following:
	{\| class="keinrahmen"		{\| class="keinrahmen"

Christian: /* POKE */

2012-10-31T12:24:09Z

POKE

← Older revision		Revision as of 14:24, 31 October 2012
Line 27:		Line 27:
	'''Example'''		'''Example'''

	Send table <var>myTable</var> to Excel using the previously established conversation <var>myExcelConv</~~code~~>. Excel will fill the area r1c1:r10c2 with the first 10 rows (entries) and first 2 columns (fields) of myTable:		Send table <var>myTable</var> to Excel using the previously established conversation <var>myExcelConv</var>. 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		SET myExcelConv POKE "r1c1:r10c2" xltable myTable

Christian: /* POKE */

2012-10-31T12:23:50Z

POKE

← Older revision		Revision as of 14:23, 31 October 2012
Line 6:		Line 6:
	== <code>POKE</code> ==		== <code>POKE</code> ==

	SET <var>conv</var> POKE <var>item format data</var>		SET <var>conv</var> POKE <var>item</var> <var>format</var> <var>data</var>

	Poke the <var>item</var> with <var>data</var> in the specified <var>format</var>.		Poke the <var>item</var> with <var>data</var> in the specified <var>format</var>.

	{\|		{\| class="einrahmen"
	\|-		\|-
	\|conv		\|<var>conv</var>
	\|the established conversation		\|the established conversation
	\|-		\|-
	\|item		\|<var>item</var>
	\|the item you wish to poke data to		\|the item you wish to poke data to
	\|-		\|-
	\|format		\|<var>format</var>
	\|the format or data~~<nowiki>~~-~~</nowiki>~~type of <var>data</var> (see <code>conv[!SERVICEFORMATS]</code> for the formats supported by the conversation's server and '<code>SET conv REQUEST</code>' for the formats supported by {{STX}})		\|the format or data-type of <var>data</var> (see <code>conv[!SERVICEFORMATS]</code> for the formats supported by the conversation's server and '<code>SET conv REQUEST</code>' for the formats supported by {{STX}})
	\|-		\|-
	\|data		\|<var>data</var>
	\|the data you want to poke (a string variable or a shell<nowiki>-</nowiki>table)		\|the data you want to poke (a string variable or a shell<nowiki>-</nowiki>table)
	\|}		\|}

Christian at 12:22, 31 October 2012

2012-10-31T12:22:51Z

← Older revision		Revision as of 14:22, 31 October 2012
Line 3:		Line 3:

	The [[Programmer_Guide/Shell_Items/DDECONV\|<code>DDECONV</code> shell item]] supports the following <code>SET</code> commands:		The [[Programmer_Guide/Shell_Items/DDECONV\|<code>DDECONV</code> shell item]] supports the following <code>SET</code> commands:


	== <code>POKE</code> ==		== <code>POKE</code> ==

Christian at 12:22, 31 October 2012

2012-10-31T12:22:37Z

← Older revision		Revision as of 14:22, 31 October 2012
Line 2:		Line 2:
	See [[Programmer Guide/Shell Items/DDECONV/DDECONV Item Attributes\|DDECONV Item Attributes]] for a list of item attributes.		See [[Programmer Guide/Shell Items/DDECONV/DDECONV Item Attributes\|DDECONV Item Attributes]] for a list of item attributes.

	~~'''Poke'''~~		The [[Programmer_Guide/Shell_Items/DDECONV\|<code>DDECONV</code> shell item]] supports the following <code>SET</code> commands:

	<code>SET <var>conv</var> POKE <var>item format data</var~~></code~~>
			== <code>POKE</code> ==

			SET <var>conv</var> POKE <var>item format data</var>

	Poke the <var>item</var> with <var>data</var> in the specified <var>format</var>.		Poke the <var>item</var> with <var>data</var> in the specified <var>format</var>.
Line 25:		Line 28:
	'''Example'''		'''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:		Send table <var>myTable</var> to Excel using the previously established conversation <var>myExcelConv</code>. 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

	~~<pre>~~
	~~SET myExcelConv POKE "r1c1:r10c2" xltable myTable~~
	~~</pre>~~
	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.		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'''~~		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'.

	<code~~>SET <var>conv</var~~> REQUEST ~~<var>item format data</var> [<var>timeout</var>]~~</code>		== <code>REQUEST</code> ==

	~~Request the~~ <var>~~data~~</var> ~~from~~ <var>item</var>~~. The macro waits~~ <var>timeout</var> ~~milliseconds for the server to return the <var>data</var>.~~		SET <var>conv</var> REQUEST <var>item format data</var> [<var>timeout</var>]

	{\|		Request the <var>data</var> from <var>item</var>. The macro waits up to <var>timeout</var> milliseconds for the server to return the <var>data</var>.

			{\| class="einrahmen"
	\|-		\|-
	\|conv		\|conv
Line 47:		Line 51:
	\|-		\|-
	\|format		\|format
	\|the format or data~~<nowiki>~~-~~</nowiki>~~type of <var>data</var>. Can be one of the following:{\|		\|the format or data-type of <var>data</var>. Can be one of the following:
			{\| class="keinrahmen"
	\|-		\|-
	\|<code>TEXT</code>		\|<code>TEXT</code>
Line 56:		Line 61:
	\|-		\|-
	\|<code>CSV</code>		\|<code>CSV</code>
	\|a table item of comma~~<nowiki>~~-~~</nowiki>~~separated values		\|a table item of comma-separated values
	\|-		\|-
	\|<code>UNICODETEXT</code>		\|<code>UNICODETEXT</code>
	\|a unicode string		\|a unicode string
	\|}		\|}


	\|-		\|-
	\|data		\| data
	\|the data variable. This is either a string for formats <code>TEXT</code> and <code>UNICODETEXT</code>, or a table for formats <code>XLTABLE</code> or <code>CSV</code>.		\| the data variable. This is either a string for formats <code>TEXT</code> and <code>UNICODETEXT</code>, or a table for formats <code>XLTABLE</code> or <code>CSV</code>.
	\|-		\|-
	\|timeout		\| timeout
	\|number of milliseconds we should wait for server to return before we fail		\| number of milliseconds we should wait for server to return before we fail
	\|}		\|}

	==~~====Advise====~~==		== <code>ADVISE</code> ==

	~~<code>~~SET conv ADVISE <var>item format</var> [<var>data</var>] /Hot\|Warm~~</code>~~		SET conv ADVISE <var>item format</var> [<var>data</var>] /Hot\|Warm

	Initiate an advise loop. The <code>[[Programmer Guide/Shell Items/DDECONV/DDECONV messages\|ADVISE]]</code> 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 <var>data</var> is necessary (because <var>data</var> 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 '<code>SET conv REQUEST</code>' is used.		Initiate an advise loop. The <code>[[Programmer Guide/Shell Items/DDECONV/DDECONV messages\|ADVISE]]</code> 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 <var>data</var> is necessary (because <var>data</var> 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 '<code>SET conv REQUEST</code>' is used.

	{\|		{\| class="einrahmen"
	\|-		\|-
	\|<var>conv</var>		\|<var>conv</var>
Line 89:		Line 92:
	\|-		\|-
	\|format		\|format
	\|the format of data~~<nowiki>~~-~~</nowiki>~~type of <var>data</var>		\|the format of data-type of <var>data</var>
	\|}		\|}

	<code>SET <var>conv</var> STOPADVISE [<var>item</var>]~~</code>~~		== <code>STOPADVISE</code> ==

			SET <var>conv</var> STOPADVISE [<var>item</var>]

	Stop an advise loop. If <var>item</var> is not specified, all advise loops for this conversation are stopped.		Stop an advise loop. If <var>item</var> is not specified, all advise loops for this conversation are stopped.
Line 105:		Line 110:
	\|}		\|}

	==~~====Execute======~~		== <code>EXECUTE</code>

	~~<code>~~SET conv EXECUTE <var>command</var~~></code~~>		SET conv EXECUTE <var>command</var>

	Execute the <var>command</var>.		Execute the <var>command</var>.