Accessor

Summary

An accessor which can perform a request transaction or a poke transaction.

Package

win32

Signature

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

Arguments

conversation

A conversation object.

item

A string or symbol.

format

A clipboard format specifier.

type

A keyword.

errorp

A boolean.

Values

result

A boolean.

Description

The accessor dde-item performs a request transaction when read. It performs a poke transaction when set.

To illustrate, the following dde-request command

(dde-request conversation item :format format :type type :errorp errorp)

can also be issued using dde-item as follows:

(dde-item conversation item :FORMAT format :TYPE type :ERRORP errorp)

Similarly, the following dde-poke command

(dde-poke conversation item data :format format :type type :errorp errorp)

can be issued using dde-item as follows:

(setf (dde-item conversation item :format format :type type :errorp errorp) data)

except that the format always returns data.

Upon success, this function returns a result of 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-poke
dde-request