Next Prev Up Top Contents Index

dde-poke

Function

Summary

Issues a poke transaction on a conversation, to set the value of a specified item.

Package

win32

Signature

dde-poke conversation item data &key format type errorp => result

Arguments

conversation

A conversation object.

item

A string or symbol.

data

A string.

format

A clipboard format specifier.

type

A keyword.

errorp

A boolean.

Values

result

A boolean.

Description

The function dde-poke issues a poke transaction on conversation to set the value of the item specified by item to the value specified by data . The argument item should be a string, or a symbol. If it is a symbol its print name is used.

The argument format should be one of the following:

A DDE format specifier, consisting of either a standard clipboard format or a registered clipboard format.

A string containing either the name of a standard clipboard format (without the CF_ prefix), or the name of a registered clipboard format.

A symbol, in which case its print name is taken to specify the clipboard format.

The keyword :text . This is the default value.

The keyword :text is treated specially. If supported by the server it uses the CF_UNICODETEXT clipboard format, otherwise it used the CF_TEXT format.

For text transactions, the default value of type indicates that data is a Lisp string to be used. If type is :string-list , then data is taken to be a list of strings, and is sent as a tab-separated string.

Alternatively, data can be a clipboard-item structure, containing a foreign pointer to the data to send and the length of the data. In this case the type argument is ignored.

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

See also

dde-item

dde-request


LispWorks Reference Manual (Windows version) - 14 Dec 2001

Next Prev Up Top Contents Index