Contents Up Previous Next

Connection

Connection overview

A connection object id is used for initiating DDE commands and requests using functions such as connection-execute, and it also has event handlers associated with it to respond to commands from the other side of the connection.

connection-advise
connection-create
connection-execute
connection-disconnect
connection-poke
connection-request
connection-start-advise
connection-stop-advise


connection-advise

long ( connection-advise long id string item string data)

Called by a server application to pass data to a client (for example, when a spreadsheet cell has been updated, and the client is interested in this value).

item is the name of the item, and data is a string representing the item's data.

Returns 1 if successful, 0 otherwise.


connection-create

long ( connection-create)

Creates a connection object. Note that if you use the server OnAcceptConnection callback, the object will be created for you. If you use OnAcceptConnectionEx then you must call connection-create yourself from within that callback.


connection-execute

long ( connection-execute long id string data)

Called by a client application to execute a command in the server. Note there is no item in this command.

data is a string representing the item's data.

Returns 1 if successful, 0 otherwise.

To get a result from a server, you need to call connection-request explicitly, since connection-execute doesn't return data.


connection-disconnect

long ( connection-disconnect long id)

Called by a client or server application to terminate this connection. After this call, the connection id is no longer valid.

Returns 1 if successful, 0 otherwise.


connection-poke

long ( connection-poke long id string item string data)

Called by a client application to poke data into the server.

item is the name of the item, and data is a string representing the item's data.

Returns 1 if successful, 0 otherwise.


connection-request

string ( connection-request long id string item)

Called by a client application to request data from a server.

item is the name of the requested data item.

Returns a string representing the data if successful, the empty string otherwise.


connection-start-advise

long ( connection-start-advise long id string item)

Called by a client application to indicate interest in a particular piece of data in a server. The client connection should then recieve OnAdvise messages when the data is updated in the server.

item is the name of the data item of interest.

Returns 1 if the advise loop is allowed, 0 otherwise.


connection-stop-advise

long ( connection-stop-advise long id string item)

Called by a client application to indicate a termination of interest in a particular piece of data in a server.

item is the name of the data item of interest.

Returns 1 if successful, 0 otherwise.