diff options
Diffstat (limited to 'doc/dde.n')
| -rw-r--r-- | doc/dde.n | 50 |
1 files changed, 25 insertions, 25 deletions
@@ -5,29 +5,29 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: dde.n,v 1.16 2004/10/27 14:24:37 dkf Exp $ +'\" RCS: @(#) $Id: dde.n,v 1.17 2004/11/25 11:28:22 dkf Exp $ '\" .so man.macros -.TH dde n 1.2 dde "Tcl Bundled Packages" +.TH dde n 1.3 dde "Tcl Bundled Packages" .BS '\" Note: do not modify the .SH NAME line immediately below! .SH NAME dde \- Execute a Dynamic Data Exchange command .SH SYNOPSIS .sp -\fBpackage require dde 1.2\fR +\fBpackage require dde 1.3\fR .sp -\fBdde \fIservername\fR ?\fI-force\fR? ?\fI-handler proc\fR? ?\fI--\fR? ?\fItopic\fR? +\fBdde servername\fR ?\fB-force\fR? ?\fB-handler \fIproc\fR? ?\fB--\fR? ?\fItopic\fR? .sp -\fBdde \fIexecute\fR ?\fI\-async\fR? \fIservice topic \fR?\fIdata\fR? +\fBdde execute\fR ?\fB\-async\fR? \fIservice topic data\fR .sp -\fBdde \fIpoke\fR \fIservice topic item data\fR +\fBdde poke\fR \fIservice topic item data\fR .sp -\fBdde \fIrequest\fR ?\fI\-binary\fR? \fIservice topic \fR?\fIdata\fR? +\fBdde request\fR ?\fB\-binary\fR? \fIservice topic item\fR .sp -\fBdde \fIservices\fR \fIservice topic \fR?\fIdata\fR? +\fBdde services \fIservice topic\fR .sp -\fBdde \fIeval\fR ?\fI\-async\fR? \fIservice topic \fR?\fIdata\fR? +\fBdde eval\fR ?\fB\-async\fR? \fItopic cmd \fR?\fIarg arg ...\fR? .BE .SH DESCRIPTION @@ -47,7 +47,7 @@ has the service name \fBExcel\fR. The following commands are a subset of the full Dynamic Data Exchange set of commands. .TP -\fBdde servername \fR?\fI-force\fR? ?\fI-handler proc\fR? ?\fI--\fR? ?\fItopic\fR? +\fBdde servername \fR?\fB-force\fR? ?\fB-handler \fIproc\fR? ?\fB--\fR? ?\fItopic\fR? \fBdde servername\fR registers the interpreter as a DDE server with the service name \fBTclEval\fR and the topic name specified by \fItopic\fR. If no \fItopic\fR is given, \fBdde servername\fR returns the name @@ -55,22 +55,22 @@ of the current topic or the empty string if it is not registered as a service. If the given \fItopic\fR name is already in use, then a suffix of the form ' #2' or ' #3' is appended to the name to make it unique. The command's result will be the name actually used. The -\fI-force\fR option is used to force registration of precisely the +\fB-force\fR option is used to force registration of precisely the given \fItopic\fR name. .IP -The \fI-handler\fR option specifies a Tcl procedure that will be called to +The \fB-handler\fR option specifies a Tcl procedure that will be called to process calls to the dde server. If the package has been loaded into a -safe interpreter then a \fI-handler\fR procedure must be defined. The +safe interpreter then a \fB-handler\fR procedure must be defined. The procedure is called with all the arguments provided by the remote call. .TP -\fBdde execute\fR ?\fI\-async\fR? \fIservice topic data\fR +\fBdde execute\fR ?\fB\-async\fR? \fIservice topic data\fR \fBdde execute\fR takes the \fIdata\fR and sends it to the server indicated by \fIservice\fR with the topic indicated by \fItopic\fR. Typically, \fIservice\fR is the name of an application, and \fItopic\fR is a file to work on. The \fIdata\fR field is given to the remote application. Typically, the application treats the \fIdata\fR field as a script, and the -script is run in the application. The \fI\-async\fR option requests +script is run in the application. The \fB\-async\fR option requests asynchronous invocation. The command returns an error message if the script did not run, unless the \fB\-async\fR flag was used, in which case the command returns immediately with no error. @@ -84,31 +84,31 @@ on. The \fIitem\fR is also application specific and is often not used, but it must always be non-null. The \fIdata\fR field is given to the remote application. .TP -\fBdde request\fR ?\fI\-binary\fR? \fIservice topic item\fR +\fBdde request\fR ?\fB\-binary\fR? \fIservice topic item\fR \fBdde request\fR is typically used to get the value of something; the value of a cell in Microsoft Excel or the text of a selection in Microsoft Word. \fIservice\fR is typically the name of an application, \fItopic\fR is typically the name of the file, and \fIitem\fR is application-specific. The command returns the value of \fIitem\fR as defined in the application. Normally this is interpreted to be a -string with terminating null. If \fI\-binary\fR is specified, the +string with terminating null. If \fB\-binary\fR is specified, the result is returned as a byte array. .TP \fBdde services \fIservice topic\fR \fBdde services\fR returns a list of service-topic pairs that currently exist on the machine. If \fIservice\fR and \fItopic\fR are -both null strings ({}), then all service-topic pairs currently -available on the system are returned. If \fIservice\fR is null and +both empty strings ({}), then all service-topic pairs currently +available on the system are returned. If \fIservice\fR is empty and \fItopic\fR is not, then all services with the specified topic are -returned. If \fIservice\fR is not null and \fItopic\fR is, all topics -for a given service are returned. If both are not null, if that -service-topic pair currently exists, it is returned; otherwise, null -is returned. +returned. If \fIservice\fR is non-empty and \fItopic\fR is, all topics +for a given service are returned. If both are non-empty, if that +service-topic pair currently exists, it is returned; otherwise, an +empty string is returned. .TP -\fBdde eval\fR ?\fI\-async\fR? \fItopic cmd \fR?\fIarg arg ...\fR? +\fBdde eval\fR ?\fB\-async\fR? \fItopic cmd \fR?\fIarg arg ...\fR? \fBdde eval\fR evaluates a command and its arguments using the interpreter specified by \fItopic\fR. The DDE service must be the \fBTclEval\fR -service. The \fI\-async\fR option requests asynchronous invocation. The +service. The \fB\-async\fR option requests asynchronous invocation. The command returns an error message if the script did not run, unless the \fB\-async\fR flag was used, in which case the command returns immediately with no error. This command can be used to replace send on Windows. |