dde-advise-stop

dde-advise-stop Function

Summary

Removes a link from a conversation specified by a given item and key.

Package

win32

Signature

dde-advise-stop conversation item &key key format errorp disconnectp no-advise-ok => result

Arguments

`conversation`⇩	A conversation object.
`item`⇩	A string or symbol.
`key`⇩	An object.
`format`⇩	A clipboard format specifier.
`errorp`⇩	A boolean.
`disconnectp`⇩	A boolean.
`no-advise-ok`⇩	A boolean.

Values

result

A boolean.

Description

The function dde-advise-stop removes a particular link from conversation specified by item, format and key. If key is the last key for the pair of item and format, then the advise loop for the pair is terminated.

See 22.2.3 Advise loops for information about DDE advise loops.

If disconnectp is t, and the last advise loop for the conversation is terminated, the conversation is disconnected.

Attempting to remove a link that does not exist raises an error, unless no-advise-ok is t.

If this function succeeds, it returns t. If it fails, the behavior depends on the value of errorp. If errorp is t (the default value), LispWorks signals an error. If errorp is nil, the function returns nil to indicate failure.