dde-advise-start*

dde-advise-start* Function

Summary

Sets up an advise loop for a specified data item for an automatically managed conversation.

Package

win32

Signature

dde-advise-start* service topic item &key key function format datap type errorp connect-error-p new-conversation-p => result

Arguments

`service`⇩	A string or symbol.
`topic`⇩	A string or symbol.
`item`⇩	A string or symbol.
`key`⇩	An object.
`function`⇩	A function name.
`format`⇩	A clipboard format specifier.
`datap`⇩	A boolean.
`type`⇩	A keyword.
`errorp`⇩	A boolean.
`connect-error-p`⇩	A boolean.
`new-conversation-p`⇩	A boolean.

Values

result⇩

A boolean.

Description

The function dde-advise-start* is similar to the dde-advise-start, and sets up an advise loop for the data item specified by item on a conversation with the server specified by service on a topic given by topic.

If connect-error-p is t (the default value) and a conversation cannot be established, then LispWorks signals an error. If connect-error-p is nil, dde-advise-start* returns nil if a conversation cannot be established.

If new-conversation-p is t then a new conversation is always established for the advise loop.

See dde-advise-start for information on DDE advise loops and the used of format, type, and datap.

key is used to identify this link. If specified as nil (the default value), it defaults to the conversation. Multiple links are permitted on a conversation with the same item and format values, as long as their key values differ.

If the link is established, the return value result is t. If the link could not be established, the behavior depends on the value of errorp. If errorp is t (the default value), LispWorks signals an error. If it is nil, the function returns nil to indicate failure.

If the link is established, the function function will be called whenever the data changes. If function is nil (the default value), the generic function dde-client-advise-data will be called.

The function specified by function should have a lambda list similar to the following:

key item data &key conversation &allow-other-keys

key and item identify the link. data contains the new data for hot links; for warm links it is nil.